Skip to content

Commit f852688

Browse files
authored
Merge pull request #56 from kecnry/fov-updates
Change definition of FOV
2 parents 03f85da + 6295501 commit f852688

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/astro_image_display_api/interface_definition.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -441,9 +441,10 @@ def set_viewport(
441441
The center of the viewport. If not given, the current center is used.
442442
fov : `astropy.units.Quantity` or float, optional
443443
The field of view (FOV) of the viewport. If not given, the current FOV
444-
is used. If a float is given, it is interpreted a size in pixels. For images
445-
that are not square, the FOV is interpreted as the size of the longer side
446-
of the image.
444+
is used. If a float is given, it is interpreted as a size in pixels. For viewers
445+
that are not square, the FOV is interpreted as the size of the shorter side
446+
of the viewer such that the FOV is guaranteed to be entirely visible
447+
regardless of the aspect ratio of the viewer.
447448
image_label : str, optional
448449
The label of the image to set the viewport for. If not given and there is
449450
only one image loaded, the viewport for that image is set. If there are

0 commit comments

Comments
 (0)