CatalogsClass

class astroquery.mast.CatalogsClass

Bases: MastQueryWithLogin

MAST catalog query class.

Class for querying MAST catalog data.

Methods Summary

__call__(*args, **kwargs)	init a fresh copy of self
authenticated()
disable_cloud_dataset()	Disables downloading public files from S3 instead of MAST
download_hsc_spectra(spectra[, ...])	Download one or more Hubble Source Catalog spectra.
enable_cloud_dataset([provider, profile, ...])	Enable downloading public files from S3 instead of MAST.
get_hsc_spectra(*args, **kwargs)	Queries the service and returns a table object.
get_hsc_spectra_async([pagesize, page])	Returns all Hubble Source Catalog spectra.
login([token, store_token, reenter_token])	Log into the MAST portal.
logout()	Log out of current MAST session.
query_criteria(*args, **kwargs)	Queries the service and returns a table object.
query_criteria_async(catalog[, pagesize, page])	Given an set of filters, returns a list of catalog entries.
query_hsc_matchid(*args, **kwargs)	Queries the service and returns a table object.
query_hsc_matchid_async(match[, version, ...])	Returns all the matches for a given Hubble Source Catalog MatchID.
query_object(*args, **kwargs)	Queries the service and returns a table object.
query_object_async(objectname[, radius, ...])	Given an object name, returns a list of catalog entries.
query_region(*args, **kwargs)	Queries the service and returns a table object.
query_region_async(coordinates[, radius, ...])	Given a sky position and radius, returns a list of catalog entries.
resolve_object(objectname)	Resolves an object name to a position on the sky.
session_info([verbose])	Displays information about current MAST user, and returns user info dictionary.

Methods Documentation

__call__(*args, **kwargs)

init a fresh copy of self

authenticated()

disable_cloud_dataset()

Disables downloading public files from S3 instead of MAST

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

Download one or more Hubble Source Catalog spectra.

Parameters:

spectraTable or Row

One or more HSC spectra to be downloaded.

download_dirstr, optional

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 ‘.’.

cachebool, optional

Default is True. If file is found on disc it will not be downloaded again. Note: has no affect when downloading curl script.

curl_flagbool, optional

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:

responselist of Response

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

Enable downloading public files from S3 instead of MAST. Requires the boto3 library to function.

Parameters:

providerstr

Which cloud data provider to use. We may in the future support multiple providers, though at the moment this argument is ignored.

profilestr

Profile to use to identify yourself to the cloud provider (usually in ~/.aws/config).

verbosebool

Default True. Logger to display extra info and warning.

get_hsc_spectra(*args, **kwargs)

Queries the service and returns a table object.

Returns all Hubble Source Catalog spectra.

Parameters:

pagesizeint, optional

Can be used to override the default pagesize. E.g. when using a slow internet connection.

pageint, optional

Can be used to override the default behavior of all results being returned to obtain one sepcific page of results.

Returns:

tableA Table object.

get_hsc_spectra_async(pagesize=None, page=None)

Returns all Hubble Source Catalog spectra.

Parameters:

pagesizeint, optional

Can be used to override the default pagesize. E.g. when using a slow internet connection.

pageint, optional

Can be used to override the default behavior of all results being returned to obtain one sepcific page of results.

Returns:

responselist of Response

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

Log into the MAST portal.

Parameters:

tokenstring, optional

Default is None. The token to authenticate the user. This can be generated at https://auth.mast.stsci.edu/token?suggested_name=Astroquery&suggested_scope=mast:exclusive_access. If not supplied, it will be prompted for if not in the keyring or set via $MAST_API_TOKEN

store_tokenbool, optional

Default False. If true, MAST token will be stored securely in your keyring.

reenter_tokenbool, optional

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.

query_criteria(*args, **kwargs)

Queries the service and returns a table object.

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

Parameters:

pagesizeint, optional

Can be used to override the default pagesize. E.g. when using a slow internet connection.

pageint, optional

Can be used to override the default behavior of all results being returned to obtain one specific page of results.

**criteria

Criteria to apply. At least one non-positional criteria must be supplied. Valid criteria are coordinates, objectname, radius (as in query_region and query_object), and all fields listed in the column documentation for the catalog being queried. The Column Name is the keyword, with the argument being one or more acceptable values for that parameter, except for fields with a float datatype where the argument should be in the form [minVal, maxVal]. For non-float type criteria wildcards maybe used (both * and % are considered wildcards), however only one wildcarded value can be processed per criterion. RA and Dec must be given in decimal degrees, and datetimes in MJD. For example: filters=[“FUV”,”NUV”],proposal_pi=”Ost*”,t_max=[52264.4586,54452.8914] For catalogs available through Catalogs.MAST (PanSTARRS), the Column Name is the keyword, and the argument should be either an acceptable value for that parameter, or a list consisting values, or tuples of decorator, value pairs (decorator, value). In addition, columns may be used to select the return columns, consisting of a list of column names. Results may also be sorted through the query with the parameter sort_by composed of either a single Column Name to sort ASC, or a list of Column Nmaes to sort ASC or tuples of Column Name and Direction (ASC, DESC) to indicate sort order (Column Name, DESC). Detailed information of Catalogs.MAST criteria usage can be found here.

Returns:

tableA Table object.

query_criteria_async(catalog, pagesize=None, page=None, **criteria)

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

Parameters:

pagesizeint, optional

Can be used to override the default pagesize. E.g. when using a slow internet connection.

pageint, optional

Can be used to override the default behavior of all results being returned to obtain one specific page of results.

**criteria

Criteria to apply. At least one non-positional criteria must be supplied. Valid criteria are coordinates, objectname, radius (as in query_region and query_object), and all fields listed in the column documentation for the catalog being queried. The Column Name is the keyword, with the argument being one or more acceptable values for that parameter, except for fields with a float datatype where the argument should be in the form [minVal, maxVal]. For non-float type criteria wildcards maybe used (both * and % are considered wildcards), however only one wildcarded value can be processed per criterion. RA and Dec must be given in decimal degrees, and datetimes in MJD. For example: filters=[“FUV”,”NUV”],proposal_pi=”Ost*”,t_max=[52264.4586,54452.8914] For catalogs available through Catalogs.MAST (PanSTARRS), the Column Name is the keyword, and the argument should be either an acceptable value for that parameter, or a list consisting values, or tuples of decorator, value pairs (decorator, value). In addition, columns may be used to select the return columns, consisting of a list of column names. Results may also be sorted through the query with the parameter sort_by composed of either a single Column Name to sort ASC, or a list of Column Nmaes to sort ASC or tuples of Column Name and Direction (ASC, DESC) to indicate sort order (Column Name, DESC). Detailed information of Catalogs.MAST criteria usage can be found here.

Returns:

responselist of Response

query_hsc_matchid(*args, **kwargs)

Queries the service and returns a table object.

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

Parameters:

matchint or Row

The matchID or HSC entry to return matches for.

versionint, optional

The HSC version to match against. Default is v3.

pagesizeint, optional

Can be used to override the default pagesize. E.g. when using a slow internet connection.

pageint, optional

Can be used to override the default behavior of all results being returned to obtain one sepcific page of results.

Returns:

tableA Table object.

query_hsc_matchid_async(match, version=3, pagesize=None, page=None)

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

Parameters:

matchint or Row

The matchID or HSC entry to return matches for.

versionint, optional

The HSC version to match against. Default is v3.

pagesizeint, optional

Can be used to override the default pagesize. E.g. when using a slow internet connection.

pageint, optional

Can be used to override the default behavior of all results being returned to obtain one sepcific page of results.

Returns:

responselist of Response

query_object(*args, **kwargs)

Queries the service and returns a table object.

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

Parameters:

objectnamestr

The name of the target around which to search.

radiusstr or Quantity object, optional

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.

catalogstr, optional

Default HSC. The catalog to be queried.

pagesizeint, optional

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.

pageint, optional

Defaulte None. Can be used to override the default behavior of all results being returned to obtain a specific page of results.

versionint, optional

Version number for catalogs that have versions. Default is highest version.

**kwargs

Catalog-specific keyword args. These can be found in the service documentation. for specific catalogs. For example one can specify the magtype for an HSC search.

Returns:

tableA Table object.

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

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

Parameters:

objectnamestr

The name of the target around which to search.

radiusstr or Quantity object, optional

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.

catalogstr, optional

Default HSC. The catalog to be queried.

pagesizeint, optional

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.

pageint, optional

Defaulte None. Can be used to override the default behavior of all results being returned to obtain a specific page of results.

versionint, optional

Version number for catalogs that have versions. Default is highest version.

**kwargs

Catalog-specific keyword args. These can be found in the service documentation. for specific catalogs. For example one can specify the magtype for an HSC search.

Returns:

responselist of Response

query_region(*args, **kwargs)

Queries the service and returns a table object.

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

Parameters:

coordinatesstr or coordinates object

The target around which to search. It may be specified as a string or as the appropriate coordinates object.

radiusstr or Quantity object, optional

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.

catalogstr, optional

Default HSC. The catalog to be queried.

versionint, optional

Version number for catalogs that have versions. Default is highest version.

pagesizeint, optional

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.

pageint, optional

Default None. Can be used to override the default behavior of all results being returned to obtain a specific page of results.

**kwargs

Other catalog-specific keyword args. These can be found in the (service documentation)[https://mast.stsci.edu/api/v0/_services.html] for specific catalogs. For example one can specify the magtype for an HSC search.

Returns:

tableA Table object.

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

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

Parameters:

coordinatesstr or coordinates object

The target around which to search. It may be specified as a string or as the appropriate coordinates object.

radiusstr or Quantity object, optional

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.

catalogstr, optional

Default HSC. The catalog to be queried.

versionint, optional

Version number for catalogs that have versions. Default is highest version.

pagesizeint, optional

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.

pageint, optional

Default None. Can be used to override the default behavior of all results being returned to obtain a specific page of results.

**kwargs

Other catalog-specific keyword args. These can be found in the (service documentation)[https://mast.stsci.edu/api/v0/_services.html] for specific catalogs. For example one can specify the magtype for an HSC search.

Returns:

responselist of Response

resolve_object(objectname)

Resolves an object name to a position on the sky.

Parameters:

objectnamestr

Name of astronomical object to resolve.

Returns:

responseSkyCoord

The sky position of the given object.

session_info(verbose=True)

Displays information about current MAST user, and returns user info dictionary.

Parameters:

verbosebool, optional

Default True. Set to False to suppress output to stdout.

Returns:

responsedict