ObservationsClass

class astroquery.mast.ObservationsClass(*args, **kwargs)[source]

Bases: astroquery.mast.MastClass

MAST Observations query class.

Class for querying MAST observational data.

Methods Summary

disable_cloud_dataset() Disables downloading public files from S3 instead of MAST
disable_s3_hst_dataset()

Deprecated since version v0.3.9.

download_products(products[, download_dir, …]) Download data products.
enable_cloud_dataset([provider, profile, …]) Enable downloading public files from S3 instead of MAST.
enable_s3_hst_dataset()

Deprecated since version v0.3.9.

filter_products(products[, mrp_only, extension]) Takes an Table of MAST observation data products and filters it based on given filters.
get_cloud_uri(data_product[, …]) For a given data product, returns the associated cloud URI.
get_cloud_uris(data_products[, …]) Takes an Table of data products and returns the associated cloud data uris.
get_hst_s3_uri(data_product[, …])

Deprecated since version v0.3.9.

get_hst_s3_uris(data_products[, …])

Deprecated since version v0.3.9.

get_metadata(query_type) Returns metadata about the requested query type.
get_product_list(*args, **kwargs) Queries the service and returns a table object.
get_product_list_async(observations) Given a “Product Group Id” (column name obsid) returns a list of associated data products.
list_missions() Lists data missions archived by MAST and avaiable through astroquery.mast.
query_criteria(*args, **kwargs) Queries the service and returns a table object.
query_criteria_async([pagesize, page]) Given an set of criteria, returns a list of MAST observations.
query_criteria_count([pagesize, page]) Given an set of filters, returns the number of MAST observations meeting those criteria.
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 MAST observations.
query_object_count(objectname[, radius, …]) Given an object name, returns the number of MAST observations.
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 MAST observations.
query_region_count(coordinates[, radius, …]) Given a sky position and radius, returns the number of MAST observations in that region.

Methods Documentation

disable_cloud_dataset()[source]

Disables downloading public files from S3 instead of MAST

disable_s3_hst_dataset()[source]

Deprecated since version v0.3.9: The disable_s3_hst_dataset function is deprecated and may be removed in a future version. Use disable_cloud_dataset instead.

download_products(products, download_dir=None, cache=True, curl_flag=False, mrp_only=False, cloud_only=False, **filters)[source]

Download data products. If cloud access is enabled, files will be downloaded from the cloud if possible.

Parameters:

products : str, list, Table

Either a single or list of obsids (as can be given to get_product_list), or a Table of products (as is returned by get_product_list)

download_dir : str, optional

Optional. Directory to download files to. Defaults to current directory.

cache : bool, 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_flag : bool, 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.

mrp_only : bool, optional

Default False. When set to true only “Minimum Recommended Products” will be returned.

cloud_only : bool, optional

Default False. If set to True and cloud data access is enabled (see enable_cloud_dataset) files that are not found in the cloud will be skipped rather than downloaded from MAST as is the default behavior. If cloud access is not enables this argument as no affect.

**filters :

Filters to be applied. Valid filters are all products fields returned by get_metadata("products") and ‘extension’ which is the desired file extension. The Column Name (or ‘extension’) is the keyword, with the argument being one or more acceptable values for that parameter. Filter behavior is AND between the filters and OR within a filter set. For example: productType=”SCIENCE”,extension=[“fits”,”jpg”]

Returns:

response : Table

The manifest of files downloaded, or status of files on disk if curl option chosen.

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

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

Parameters:

provider : str

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

profile : str

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

verbose : bool

Default True. Logger to display extra info and warning.

enable_s3_hst_dataset()[source]

Deprecated since version v0.3.9: The enable_s3_hst_dataset function is deprecated and may be removed in a future version. Use enable_cloud_dataset instead.

filter_products(products, mrp_only=False, extension=None, **filters)[source]

Takes an Table of MAST observation data products and filters it based on given filters.

Parameters:

products : Table

Table containing data products to be filtered.

mrp_only : bool, optional

Default False. When set to true only “Minimum Recommended Products” will be returned.

extension : string or array, optional

Default None. Option to filter by file extension.

**filters :

Filters to be applied. Valid filters are all products fields listed here. The column name is the keyword, with the argument being one or more acceptable values for that parameter. Filter behavior is AND between the filters and OR within a filter set. For example: productType=”SCIENCE”,extension=[“fits”,”jpg”]

Returns:

response : Table

get_cloud_uri(data_product, include_bucket=True, full_url=False)[source]

For a given data product, returns the associated cloud URI. If the product is from a mission that does not support cloud access an exception is raised. If the mission is supported but the product cannot be found in the cloud, the returned path is None.

Parameters:

data_product : Row

Product to be converted into cloud data uri.

include_bucket : bool

When either to include the cloud bucket prefix in the result or not.

full_url : bool

Return a HTTP fetchable url instead of a uri.

Returns:

response : str or None

Cloud URI generated from the data product. If the product cannot be found in the cloud, None is returned.

get_cloud_uris(data_products, include_bucket=True, full_url=False)[source]

Takes an Table of data products and returns the associated cloud data uris.

Parameters:

data_products : Table

Table containing products to be converted into cloud data uris.

include_bucket : bool

When either to include the cloud bucket prefix in the result or not.

full_url : bool

Return a HTTP fetchable url instead of a uri.

Returns:

response : list

List of URIs generated from the data products, list way contain entries that are None if data_products includes products not found in the cloud.

get_hst_s3_uri(data_product, include_bucket=True, full_url=False)[source]

Deprecated since version v0.3.9: The get_hst_s3_uri function is deprecated and may be removed in a future version. Use get_cloud_uri instead.

get_hst_s3_uris(data_products, include_bucket=True, full_url=False)[source]

Deprecated since version v0.3.9: The get_hst_s3_uris function is deprecated and may be removed in a future version. Use get_cloud_uris instead.

get_metadata(query_type)[source]

Returns metadata about the requested query type.

Parameters:

query_type : str

The query to get metadata for. Options are observations, and products.

Returns:

response : Table

The metadata table.

get_product_list(*args, **kwargs)

Queries the service and returns a table object.

Given a “Product Group Id” (column name obsid) returns a list of associated data products. See column documentation here.

Parameters:

observations : str or Row or list/Table of same

Row/Table of MAST query results (e.g. output from query_object) or single/list of MAST Product Group Id(s) (obsid). See description here.

Returns:

table : A Table object.

get_product_list_async(observations)[source]

Given a “Product Group Id” (column name obsid) returns a list of associated data products. See column documentation here.

Parameters:

observations : str or Row or list/Table of same

Row/Table of MAST query results (e.g. output from query_object) or single/list of MAST Product Group Id(s) (obsid). See description here.

Returns:

response : list of Response

list_missions()[source]

Lists data missions archived by MAST and avaiable through astroquery.mast.

Returns:

response : list

List of available missions.

query_criteria(*args, **kwargs)

Queries the service and returns a table object.

Given an set of criteria, returns a list of MAST observations. Valid criteria are returned by get_metadata("observations")

Parameters:

pagesize : int, optional

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

page : int, optional

Can be used to override the default behavior of all results being returned to obtain one sepcific 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 observation fields returned by the get_metadata("observations"). 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]

Returns:

table : A Table object.

query_criteria_async(pagesize=None, page=None, **criteria)[source]

Given an set of criteria, returns a list of MAST observations. Valid criteria are returned by get_metadata("observations")

Parameters:

pagesize : int, optional

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

page : int, optional

Can be used to override the default behavior of all results being returned to obtain one sepcific 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 observation fields returned by the get_metadata("observations"). 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]

Returns:

response : list of Response

query_criteria_count(pagesize=None, page=None, **criteria)[source]

Given an set of filters, returns the number of MAST observations meeting those criteria.

Parameters:

pagesize : int, optional

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

page : int, optional

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

**criteria

Criteria to apply. At least one non-positional criterion must be supplied. Valid criteria are coordinates, objectname, radius (as in query_region and query_object), and all observation fields listed here. 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]

Returns:

response : int

query_object(*args, **kwargs)

Queries the service and returns a table object.

Given an object name, returns a list of MAST observations. See column documentation here.

Parameters:

objectname : str

The name of the target around which to search.

radius : str 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.

pagesize : int, 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.

page : int, optional

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

Returns:

table : A Table object.

query_object_async(objectname, radius=<Quantity 0.2 deg>, pagesize=None, page=None)[source]

Given an object name, returns a list of MAST observations. See column documentation here.

Parameters:

objectname : str

The name of the target around which to search.

radius : str 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.

pagesize : int, 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.

page : int, optional

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

Returns:

response : list of Response

query_object_count(objectname, radius=<Quantity 0.2 deg>, pagesize=None, page=None)[source]

Given an object name, returns the number of MAST observations.

Parameters:

objectname : str

The name of the target around which to search.

radius : str or Quantity object, optional

The string must be parsable by Angle. The appropriate Quantity object from units may also be used. Defaults to 0.2 deg.

pagesize : int, optional

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

page : int, optional

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

Returns:

response : int

query_region(*args, **kwargs)

Queries the service and returns a table object.

Given a sky position and radius, returns a list of MAST observations. See column documentation here.

Parameters:

coordinates : 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, 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.

pagesize : int, 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.

page : int, optional

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

Returns:

table : A Table object.

query_region_async(coordinates, radius=<Quantity 0.2 deg>, pagesize=None, page=None)[source]

Given a sky position and radius, returns a list of MAST observations. See column documentation here.

Parameters:

coordinates : 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, 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.

pagesize : int, 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.

page : int, optional

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

Returns:

response : list of Response

query_region_count(coordinates, radius=<Quantity 0.2 deg>, pagesize=None, page=None)[source]

Given a sky position and radius, returns the number of MAST observations in that region.

Parameters:

coordinates : 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, optional

The string must be parsable by Angle. The appropriate Quantity object from units may also be used. Defaults to 0.2 deg.

pagesize : int, optional

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

page : int, optional

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

Returns:

response : int