Skip to content

Change definition of FOV #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 26, 2025
Merged

Change definition of FOV #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3eb5a2c
update docstring for fov
kecnry Jun 26, 2025
6295501
Apply suggestions from code review
kecnry Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/astro_image_display_api/interface_definition.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,9 +441,10 @@ def set_viewport(
The center of the viewport. If not given, the current center is used.
fov : `astropy.units.Quantity` or float, optional
The field of view (FOV) of the viewport. If not given, the current FOV
is used. If a float is given, it is interpreted a size in pixels. For images
that are not square, the FOV is interpreted as the size of the longer side
of the image.
is used. If a float is given, it is interpreted as a size in pixels. For viewers
that are not square, the FOV is interpreted as the size of the shorter side
of the viewer such that the FOV is guaranteed to be entirely visible
regardless of the aspect ratio of the viewer.
image_label : str, optional
The label of the image to set the viewport for. If not given and there is
only one image loaded, the viewport for that image is set. If there are
Expand Down