Skip to content

Clarifying documentation for MastMissions radius value #3364

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 1 commit into from
Jun 30, 2025
Merged

Clarifying documentation for MastMissions radius value #3364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 27 additions & 36 deletions astroquery/mast/missions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,19 +188,16 @@ def query_region_async(self, coordinates, *, radius=3*u.arcmin, limit=5000, offs
coordinates : str or `~astropy.coordinates` object
The target around which to search. It may be specified as a
string or as the appropriate `~astropy.coordinates` object.
radius : str or `~astropy.units.Quantity` object, optional
Default 3 degrees.
radius : str or `~astropy.units.Quantity` object
Default is 3 arcminutes. The radius around the coordinates to search within.
The string must be parsable by `~astropy.coordinates.Angle`. The
appropriate `~astropy.units.Quantity` object from
`~astropy.units` may also be used. Defaults to 3 arcminutes.
appropriate `~astropy.units.Quantity` object from `~astropy.units` may also be used.
limit : int
Optional and default is 5000.
the maximum number of dataset IDs in the results.
Default is 5000. The maximum number of dataset IDs in the results.
offset : int
Optional and default is 0
the number of records you wish to skip before selecting records.
select_cols: list, None
Default None. Names of columns that will be included in the result table.
Default is 0. The number of records you wish to skip before selecting records.
select_cols: list, optional
Default is None. Names of columns that will be included in the result table.
If None, a default set of columns will be returned.
**criteria
Other mission-specific criteria arguments.
Expand All @@ -224,7 +221,7 @@ def query_region_async(self, coordinates, *, radius=3*u.arcmin, limit=5000, offs
# Put coordinates and radius into consistent format
coordinates = commons.parse_coordinates(coordinates)

# if radius is just a number we assume degrees
# If radius is just a number, assume arcminutes
radius = coord.Angle(radius, u.arcmin)

# Dataset ID column should always be returned
Expand All @@ -233,7 +230,7 @@ def query_region_async(self, coordinates, *, radius=3*u.arcmin, limit=5000, offs
elif self.mission == 'ullyses':
select_cols = self._default_ullyses_cols

# basic params
# Basic params
params = {'target': [f"{coordinates.ra.deg} {coordinates.dec.deg}"],
'radius': radius.arcsec,
'radius_units': 'arcseconds',
Expand All @@ -258,23 +255,20 @@ def query_criteria_async(self, *, coordinates=None, objectname=None, radius=3*u.
string or as the appropriate `~astropy.coordinates` object.
objectname : str
The name of the target around which to search.
radius : str or `~astropy.units.Quantity` object, optional
Default 3 degrees.
radius : str or `~astropy.units.Quantity` object
Default is 3 arcminutes. The radius around the coordinates to search within.
The string must be parsable by `~astropy.coordinates.Angle`. The
appropriate `~astropy.units.Quantity` object from
`~astropy.units` may also be used. Defaults to 3 arcminutes.
appropriate `~astropy.units.Quantity` object from `~astropy.units` may also be used.
limit : int
Optional and default is 5000.
the maximum number of dataset IDs in the results.
Default is 5000. The maximum number of dataset IDs in the results.
offset : int
Optional and default is 0.
the number of records you wish to skip before selecting records.
select_cols: list, None
Default None. Names of columns that will be included in the result table.
Default is 0. The number of records you wish to skip before selecting records.
select_cols: list, optional
Default is None. Names of columns that will be included in the result table.
If None, a default set of columns will be returned.
resolver : str, optional
The resolver to use when resolving a named target into coordinates. Valid options are "SIMBAD" and "NED".
If not specified, the default resolver order will be used. Please see the
Default is None. The resolver to use when resolving a named target into coordinates. Valid options are
"SIMBAD" and "NED". If not specified, the default resolver order will be used. Please see the
`STScI Archive Name Translation Application (SANTA) <https://mastresolver.stsci.edu/Santa-war/>`__
for more information. Default is None.
**criteria
Expand Down Expand Up @@ -339,22 +333,19 @@ def query_object_async(self, objectname, *, radius=3*u.arcmin, limit=5000, offse
objectname : str
The name of the target around which to search.
radius : str or `~astropy.units.Quantity` object, optional
Default 3 arcmin.
The string must be parsable by `~astropy.coordinates.Angle`.
The appropriate `~astropy.units.Quantity` object from
`~astropy.units` may also be used. Defaults to 3 arcminutes.
Default is 3 arcminutes. The radius around the coordinates to search within.
The string must be parsable by `~astropy.coordinates.Angle`. The
appropriate `~astropy.units.Quantity` object from `~astropy.units` may also be used.
limit : int
Optional and default is 5000.
the maximum number of dataset IDs in the results.
Default is 5000. The maximum number of dataset IDs in the results.
offset : int
Optional and default is 0.
the number of records you wish to skip before selecting records.
select_cols: list, None
Default None. Names of columns that will be included in the result table.
Default is 0. The number of records you wish to skip before selecting records.
select_cols: list, optional
Default is None. Names of columns that will be included in the result table.
If None, a default set of columns will be returned.
resolver : str, optional
The resolver to use when resolving a named target into coordinates. Valid options are "SIMBAD" and "NED".
If not specified, the default resolver order will be used. Please see the
Default is None. The resolver to use when resolving a named target into coordinates. Valid options are
"SIMBAD" and "NED". If not specified, the default resolver order will be used. Please see the
`STScI Archive Name Translation Application (SANTA) <https://mastresolver.stsci.edu/Santa-war/>`__
for more information. Default is None.
**criteria
Expand Down
Loading