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])Attempts to 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 astropy.table.Table
of MAST observation data products and filters it based on given filters.get_cloud_uri
(dataProduct[, includeBucket, …])Turns a dataProduct into a S3 URI get_cloud_uris
(dataProducts[, …])Takes an astropy.table.Table
of data products and turns them into s3 uris.get_hst_s3_uri
(dataProduct[, includeBucket, …])Deprecated since version v0.3.9.
get_hst_s3_uris
(dataProducts[, …])Deprecated since version v0.3.9.
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 filters, 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_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, **filters)[source]¶ Download data products.
Parameters: products : str, list,
astropy.table.Table
Either a single or list of obsids (as can be given to
get_product_list
), or a Table of products (as is returned byget_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.
**filters :
Filters to be applied. Valid filters are all products fields listed here 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)[source]¶ Attempts to enable downloading public files from S3 instead of MAST. Requires the boto3 library to function.
-
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
astropy.table.Table
of MAST observation data products and filters it based on given filters.Parameters: products :
astropy.table.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, 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
(dataProduct, includeBucket=True, fullUrl=False)[source]¶ Turns a dataProduct into a S3 URI
-
get_cloud_uris
(dataProducts, includeBucket=True, fullUrl=False)[source]¶ Takes an
astropy.table.Table
of data products and turns them into s3 uris.
-
get_hst_s3_uri
(dataProduct, includeBucket=True, fullUrl=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
(dataProducts, includeBucket=True, fullUrl=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_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
astropy.table.Row
or list/Table of sameRow/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
astropy.table.Row
or list/Table of sameRow/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(
requests.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 filters, returns a list of MAST observations. See column documentation here.
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
andquery_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: table : A
Table
object.
-
query_criteria_async
(pagesize=None, page=None, **criteria)[source]¶ Given an set of filters, returns a list of MAST observations. See column documentation here.
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
andquery_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 : list(
requests.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
andquery_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, optionalDefault 0.2 degrees. The string must be parsable by
astropy.coordinates.Angle
. The appropriateQuantity
object fromastropy.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, optionalDefault 0.2 degrees. The string must be parsable by
astropy.coordinates.Angle
. The appropriateQuantity
object fromastropy.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
requests.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, optionalThe string must be parsable by
astropy.coordinates.Angle
. The appropriateQuantity
object fromastropy.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
astropy.coordinates
objectThe target around which to search. It may be specified as a string or as the appropriate
astropy.coordinates
object.radius : str or
Quantity
object, optionalDefault 0.2 degrees. The string must be parsable by
astropy.coordinates.Angle
. The appropriateQuantity
object fromastropy.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
astropy.coordinates
objectThe target around which to search. It may be specified as a string or as the appropriate
astropy.coordinates
object.radius : str or
Quantity
object, optionalDefault 0.2 degrees. The string must be parsable by
astropy.coordinates.Angle
. The appropriateQuantity
object fromastropy.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
requests.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
astropy.coordinates
objectThe target around which to search. It may be specified as a string or as the appropriate
astropy.coordinates
object.radius : str or
Quantity
object, optionalThe string must be parsable by
astropy.coordinates.Angle
. The appropriateQuantity
object fromastropy.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
-