Archive MAST Catalogs

Catalogs hosted at MAST (HSC, Pan-STARRS, TIC, GAIA, ...).

• Module name: mast_catalogs
• Python class: astroquery.mast.Catalogs
• Functions: 19

Call any function below with the astroquery_execute MCP tool. Descriptions are taken from the upstream astroquery/astropy docstrings.

Function	Summary
authenticated	Catalogs.authenticated
clear_cache	Removes all cache files.
disable_cloud_dataset	Deprecated: v0.4.8
download_hsc_spectra	Download one or more Hubble Source Catalog spectra.
enable_cloud_dataset	Deprecated: v0.4.8
get_hsc_spectra	Queries the service and returns a table object.
get_hsc_spectra_async	Returns all Hubble Source Catalog spectra.
login	Log into the MAST portal.
logout	Log out of current MAST session.
query_criteria	Queries the service and returns a table object.
query_criteria_async	Given an set of filters, returns a list of catalog entries.
query_hsc_matchid	Queries the service and returns a table object.
query_hsc_matchid_async	Returns all the matches for a given Hubble Source Catalog MatchID.
query_object	Queries the service and returns a table object.
query_object_async	Given an object name, returns a list of catalog entries.
query_region	Queries the service and returns a table object.
query_region_async	Given a sky position and radius, returns a list of catalog entries.
reset_cache_location	Resets the cache location to the default astropy cache
resolve_object	Resolves an object name to a position on the sky.

Functions

authenticated

No description in upstream docstring.

Catalogs.authenticated()

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="authenticated",
    params={},
)

Parameters

No parameters.

clear_cache

Removes all cache files.

Catalogs.clear_cache()

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="clear_cache",
    params={},
)

Parameters

No parameters.

disable_cloud_dataset

No description in upstream docstring.

Catalogs.disable_cloud_dataset()

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="disable_cloud_dataset",
    params={},
)

Parameters

No parameters.

download_hsc_spectra

Download one or more Hubble Source Catalog spectra.

Catalogs.download_hsc_spectra(spectra, *, download_dir=None, cache=True, curl_flag=False)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="download_hsc_spectra",
    params={"spectra": "<spectra>"},
)

Parameters

Parameter	Type	Default	Description
spectra (required)	Table or Row		One or more HSC spectra to be downloaded.
download_dir	str	None	Specify the base directory to download spectra into. Spectra will be saved in the subdirectory download_dir/mastDownload/HSC. If download_dir is not specified the base directory will be '.'.
cache	bool	True	Default is True. If file is found on disc it will not be downloaded again. Note: has no affect when downloading curl script.
curl_flag	bool	False	Default is False. If true instead of downloading files directly, a curl script will be downloaded that can be used to download the data files at a later time.

Returns

list of Response`` —

enable_cloud_dataset

No description in upstream docstring.

Catalogs.enable_cloud_dataset(provider='AWS', profile=None, verbose=True)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="enable_cloud_dataset",
    params={},
)

Parameters

Parameter	Type	Default	Description
provider	str	'AWS'	Which cloud data provider to use. We may in the future support multiple providers, though at the moment this argument is ignored.
profile	str	None	Profile to use to identify yourself to the cloud provider (usually in ~/.aws/config).
verbose	bool	True	Default True. Logger to display extra info and warning.

get_hsc_spectra

Queries the service and returns a table object.

Catalogs.get_hsc_spectra(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="get_hsc_spectra",
    params={},
)

Returns all Hubble Source Catalog spectra.

Parameters

Parameter	Type	Default	Description
*args
**kwargs

Returns

A Table object. —

get_hsc_spectra_async

Returns all Hubble Source Catalog spectra.

Catalogs.get_hsc_spectra_async(*, pagesize=None, page=None)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="get_hsc_spectra_async",
    params={},
)

Parameters

Parameter	Type	Default	Description
pagesize	int	None	Can be used to override the default pagesize. E.g. when using a slow internet connection.
page	int	None	Can be used to override the default behavior of all results being returned to obtain one specific page of results.

Returns

list of Response`` —

login

Log into the MAST portal.

Catalogs.login(token=None, store_token=False, reenter_token=False)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="login",
    params={},
)

Parameters

Parameter	Type	Default	Description
token	string	None	Default is None. The token to authenticate the user. This can be generated at https://ssoportal.stsci.edu/idp/profile/SAML2/Redirect/SSO?execution=e1s1 If not supplied, it will be prompted for if not in the keyring or set via $MAST_API_TOKEN
store_token	bool	False	Default False. If true, MAST token will be stored securely in your keyring.
reenter_token	bool	False	Default False. Asks for the token even if it is already stored in the keyring or $MAST_API_TOKEN environment variable. This is the way to overwrite an already stored password on the keyring.

logout

Log out of current MAST session.

Catalogs.logout()

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="logout",
    params={},
)

Parameters

No parameters.

query_criteria

Queries the service and returns a table object.

Catalogs.query_criteria(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_criteria",
    params={},
)

Given an set of filters, returns a list of catalog entries. See column documentation for specific catalogs here.

Parameters

Parameter	Type	Default	Description
*args
**kwargs

Returns

A Table object. —

query_criteria_async

Given an set of filters, returns a list of catalog entries.

Catalogs.query_criteria_async(catalog, *, pagesize=None, page=None, resolver=None, **criteria)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_criteria_async",
    params={"catalog": "<catalog>"},
)

See column documentation for specific catalogs here.

Parameters

Parameter	Type	Default	Description
catalog (required)	str		The catalog to be queried.
pagesize	int	None	Can be used to override the default pagesize. E.g. when using a slow internet connection.
page	int	None	Can be used to override the default behavior of all results being returned to obtain one specific page of results.
resolver	str	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) for more information. Default is None.
**criteria

Returns

list of Response`` —

query_hsc_matchid

Queries the service and returns a table object.

Catalogs.query_hsc_matchid(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_hsc_matchid",
    params={},
)

Returns all the matches for a given Hubble Source Catalog MatchID.

Parameters

Parameter	Type	Default	Description
*args
**kwargs

Returns

A Table object. —

query_hsc_matchid_async

Returns all the matches for a given Hubble Source Catalog MatchID.

Catalogs.query_hsc_matchid_async(match, *, version=3, pagesize=None, page=None)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_hsc_matchid_async",
    params={"match": "<match>"},
)

Parameters

Parameter	Type	Default	Description
match (required)	int or Row		The matchID or HSC entry to return matches for.
version	int	3	The HSC version to match against. Default is v3.
pagesize	int	None	Can be used to override the default pagesize. E.g. when using a slow internet connection.
page	int	None	Can be used to override the default behavior of all results being returned to obtain one specific page of results.

Returns

list of Response`` —

query_object

Queries the service and returns a table object.

Catalogs.query_object(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_object",
    params={},
)

Given an object name, returns a list of catalog entries. See column documentation for specific catalogs here.

Parameters

Parameter	Type	Default	Description
*args
**kwargs

Returns

A Table object. —

query_object_async

Given an object name, returns a list of catalog entries.

Catalogs.query_object_async(objectname, *, radius=<Quantity 0.2 deg>, catalog='Hsc', pagesize=None, page=None, version=None, resolver=None, **criteria)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_object_async",
    params={"objectname": "<objectname>"},
)

See column documentation for specific catalogs here.

Parameters

Parameter	Type	Default	Description
objectname (required)	str		The name of the target around which to search.
radius	str or Quantity object	<Quantity 0.2 deg>	Default 0.2 degrees. The string must be parsable by Angle. The appropriate Quantity object from units may also be used. Defaults to 0.2 deg.
catalog	str	'Hsc'	Default HSC. The catalog to be queried.
pagesize	int	None	Default None. Can be used to override the default pagesize for (set in configs) this query only. E.g. when using a slow internet connection.
page	int	None	Default None. Can be used to override the default behavior of all results being returned to obtain a specific page of results.
version	int	None	Version number for catalogs that have versions. Default is highest version.
resolver	str	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) for more information. Default is None.
**criteria

Returns

list of Response`` —

query_region

Queries the service and returns a table object.

Catalogs.query_region(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_region",
    params={},
)

Given a sky position and radius, returns a list of catalog entries. See column documentation for specific catalogs here.

Parameters

Parameter	Type	Default	Description
*args
**kwargs

Returns

A Table object. —

query_region_async

Given a sky position and radius, returns a list of catalog entries.

Catalogs.query_region_async(coordinates, *, radius=<Quantity 0.2 deg>, catalog='Hsc', version=None, pagesize=None, page=None, **criteria)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="query_region_async",
    params={"coordinates": "<coordinates>"},
)

See column documentation for specific catalogs here.

Parameters

Parameter	Type	Default	Description
coordinates (required)	str or coordinates object		The target around which to search. It may be specified as a string or as the appropriate coordinates object.
radius	str or Quantity object	<Quantity 0.2 deg>	Default 0.2 degrees. The string must be parsable by Angle. The appropriate Quantity object from units may also be used. Defaults to 0.2 deg.
catalog	str	'Hsc'	Default HSC. The catalog to be queried.
version	int	None	Version number for catalogs that have versions. Default is highest version.
pagesize	int	None	Default None. Can be used to override the default pagesize for (set in configs) this query only. E.g. when using a slow internet connection.
page	int	None	Default None. Can be used to override the default behavior of all results being returned to obtain a specific page of results.
**criteria

Returns

list of Response`` —

reset_cache_location

Resets the cache location to the default astropy cache

Catalogs.reset_cache_location()

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="reset_cache_location",
    params={},
)

Parameters

No parameters.

resolve_object

Resolves an object name to a position on the sky.

Catalogs.resolve_object(objectname, *, resolver=None, resolve_all=False)

Call via MCP

astroquery_execute(
    module_name="mast_catalogs",
    function_name="resolve_object",
    params={"objectname": "<objectname>"},
)

Parameters

Parameter	Type	Default	Description
objectname (required)	str		Name of astronomical object to resolve.
resolver	str	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) for more information. If resolve_all is True, this parameter will be ignored. Default is None.
resolve_all	bool	False	If True, will try to resolve the object name using all available resolvers ("NED", "SIMBAD"). Function will return a dictionary where the keys are the resolver names and the values are the resolved coordinates. Default is False.

Returns

``SkyCoord, dict — If `resolve_all` is False, returns a `SkyCoord` object with the resolved coordinates. If `resolve_all` is True, returns a dictionary where the keys are the resolver names and the values are `SkyCoord` objects with the resolved coordinates.