Skip to content

Commit 32e06b9

Browse files
committed
Clarify how viewport for non-square images are handled
1 parent 428d510 commit 32e06b9

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/astro_image_display_api/interface_definition.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,15 +229,16 @@ def set_viewport(
229229
image_label: str | None = None
230230
) -> None:
231231
"""
232-
Set the viewport of the image, which defines the center and field of viea.
232+
Set the viewport of the image, which defines the center and field of view.
233233
234234
Parameters
235235
----------
236236
center : `astropy.coordinates.SkyCoord` or tuple of float, optional
237237
The center of the viewport. If not given, the current center is used.
238238
fov : `astropy.units.Quantity` or float, optional
239239
The field of view (FOV) of the viewport. If not given, the current FOV
240-
is used. If a float is given, it is interpreted a size in pixels.
240+
is used. If a float is given, it is interpreted a size in pixels. For images that are
241+
not square, the FOV is interpreted as the size of the longer side of the image.
241242
image_label : str, optional
242243
The label of the image to set the viewport for. If not given and there is
243244
only one image loaded, the viewport for that image is set. If there are

0 commit comments

Comments
 (0)