MAST Observations
Mikulski Archive for Space Telescopes observations (HST, JWST, TESS, Kepler, …).
Module name:
mastPython class:
astroquery.mast.ObservationsFunctions: 27
Call any function below with the astroquery_execute MCP tool. Descriptions are taken from the upstream astroquery/astropy docstrings.
Function |
Summary |
|---|---|
Observations.authenticated |
|
Removes all cache files. |
|
Disables downloading public files from S3 instead of MAST. |
|
Downloads a single file based on the data URI |
|
Download data products. |
|
Enable downloading public files from S3 instead of MAST. |
|
Filters an |
|
For a given data product, returns the associated cloud URI. |
|
Given an |
|
Returns metadata about the requested query type. |
|
Queries the service and returns a table object. |
|
Given a “Product Group Id” (column name obsid) returns a list of associated data products. |
|
Given a “Product Group Id” (column name obsid), returns a list of associated data products with |
|
Lists data missions archived by MAST and available through |
|
Log into the MAST portal. |
|
Log out of current MAST session. |
|
Queries the service and returns a table object. |
|
Given an set of criteria, returns a list of MAST observations. |
|
Given an set of filters, returns the number of MAST observations meeting those criteria. |
|
Queries the service and returns a table object. |
|
Given an object name, returns a list of MAST observations. |
|
Given an object name, returns the number of MAST observations. |
|
Queries the service and returns a table object. |
|
Given a sky position and radius, returns a list of MAST observations. |
|
Given a sky position and radius, returns the number of MAST observations in that region. |
|
Resets the cache location to the default astropy cache |
|
Resolves an object name to a position on the sky. |
Functions
authenticated
Call via MCP
astroquery_execute(
module_name="mast",
function_name="authenticated",
params={},
)
- ObservationsClass.authenticated()
clear_cache
Call via MCP
astroquery_execute(
module_name="mast",
function_name="clear_cache",
params={},
)
- ObservationsClass.clear_cache()
Removes all cache files.
disable_cloud_dataset
Call via MCP
astroquery_execute(
module_name="mast",
function_name="disable_cloud_dataset",
params={},
)
- ObservationsClass.disable_cloud_dataset()
Disables downloading public files from S3 instead of MAST.
download_file
Call via MCP
astroquery_execute(
module_name="mast",
function_name="download_file",
params={"uri": "<uri>"},
)
- ObservationsClass.download_file(uri, *, local_path=None, base_url=None, cache=True, cloud_only=False, verbose=True)
Downloads a single file based on the data URI
- Parameters:
uri (
str) – The product dataURI, e.g. mast:JWST/product/jw00736-o039_t001_miri_ch1-long_x1d.fitslocal_path (
str) – Directory or filename to which the file will be downloaded. Defaults to current working directory.base_url (
str) – A base url to use when downloading. Default is the MAST Portal APIcache (
bool) – Default is True. If file is found on disk it will not be downloaded again.cloud_only (
bool, optional) – Default False. If set to True and cloud data access is enabled (seeenable_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.verbose (
bool, optional) – Default True. Whether to show download progress in the console.
- Returns:
download_products
Call via MCP
astroquery_execute(
module_name="mast",
function_name="download_products",
params={"products": "<products>"},
)
- ObservationsClass.download_products(products, *, download_dir=None, flat=False, cache=True, curl_flag=False, mrp_only=False, cloud_only=False, verbose=True, **filters)
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 toget_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.flat (
bool, optional) – Default is False. If set to True, and download_dir is specified, it will put all files into download_dir without subdirectories. Or if set to True and download_dir is not specified, it will put files in the current directory, again with no subdirs. The default of False puts files into the standard directory structure of “mastDownload/<obs_collection>/<obs_id>/”. If curl_flag=True, the flat flag has no effect, as astroquery does not control how MAST generates the curl download script.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 (seeenable_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.verbose (
bool, optional) – Default True. Whether to show download progress in the console.**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 – The manifest of files downloaded, or status of files on disk if curl option chosen.
- Return type:
enable_cloud_dataset
Call via MCP
astroquery_execute(
module_name="mast",
function_name="enable_cloud_dataset",
params={},
)
- ObservationsClass.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:
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.
filter_products
Call via MCP
astroquery_execute(
module_name="mast",
function_name="filter_products",
params={"products": "<products>"},
)
- ObservationsClass.filter_products(products, *, mrp_only=False, extension=None, **filters)
Filters an
Tableof data products 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 (
stringorarray, optional) – Default None. Option to filter by file extension.**filters –
Column-based filters to apply to the products table. Valid filters are all products fields listed here.
Each keyword corresponds to a column name in the table, with the argument being one or more acceptable values for that column. AND logic is applied between filters.
Within each column’s filter set:
Positive (non-negated) values are combined with OR logic.
Any negated values (prefixed with “!”) are combined with AND logic against the ORed positives. This results in: (NOT any_negatives) AND (any_positives) Examples:
productType=['A', 'B', '!C']→ (productType != C) AND (productType == A OR productType == B)size=['!14400', '<20000']→ (size != 14400) AND (size < 20000)
For columns with numeric data types (int or float), filter values can be expressed in several ways:
A single number:
size=100A range in the form “start..end”:
size="100..1000"A comparison operator followed by a number:
size=">=1000"A list of expressions (OR logic):
size=[100, "500..1000", ">=1500"]
- Returns:
response – Filtered table of data products.
- Return type:
get_cloud_uri
Call via MCP
astroquery_execute(
module_name="mast",
function_name="get_cloud_uri",
params={"data_product": "<data_product>"},
)
- ObservationsClass.get_cloud_uri(data_product, *, include_bucket=True, full_url=False)
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,str) – Product to be converted into cloud data uri.include_bucket (
bool) – Default True. When false returns the path of the file relative to the top level cloud storage location. Must be set to False when using the full_url argument.full_url (
bool) – Default False. Return an HTTP fetchable url instead of a cloud uri. Must set include_bucket to False to use this option.
- Returns:
response – Cloud URI generated from the data product. If the product cannot be found in the cloud, None is returned.
- Return type:
get_cloud_uris
Call via MCP
astroquery_execute(
module_name="mast",
function_name="get_cloud_uris",
params={},
)
- ObservationsClass.get_cloud_uris(data_products=None, *, include_bucket=True, full_url=False, pagesize=None, page=None, mrp_only=False, extension=None, filter_products={}, return_uri_map=False, verbose=True, **criteria)
Given an
Tableof data products or query criteria and filter parameters, returns the associated cloud data URIs.- Parameters:
data_products (
Table,list) – Table containing products or list of MAST uris to be converted into cloud data uris. If provided, this will supercede page_size, page, or any keyword arguments passed in as criteria.include_bucket (
bool) – Default True. When False, returns the path of the file relative to the top level cloud storage location. Must be set to False when using the full_url argument.full_url (
bool) – Default False. Return an HTTP fetchable url instead of a cloud uri. Must set include_bucket to False to use this option.pagesize (
int, optional) – Default None. Can be used to override the default pagesize when making a query. E.g. when using a slow internet connection. Query criteria must also be provided.page (
int, optional) – Default None. Can be used to override the default behavior of all results being returned for a query to obtain one specific page of results. Query criteria must also be provided.mrp_only (
bool, optional) – Default False. When set to True, only “Minimum Recommended Products” will be returned.extension (
stringorarray, optional) – Default None. Option to filter by file extension.filter_products (
dict, optional) – Filters to be applied to data products. Valid filters are all products fields listed here. The column name as a string is the key. The corresponding value is 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”]}return_uri_map (
bool, optional) – Default False. If set to True, returns a dictionary mapping the original data product URIs to their corresponding cloud URIs. This is useful for tracking which products were successfully converted to cloud URIs.verbose (
bool, optional) – Default True. Whether to issue warnings if a product cannot be found in the cloud.**criteria – Criteria to apply. At least one non-positional criteria must be supplied. Valid criteria are coordinates, objectname, radius (as in
query_regionandquery_object), and all observation fields returned by theget_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 URIs generated from the data products. May contain entries that are None if data_products includes products not found in the cloud.
- Return type:
get_metadata
Call via MCP
astroquery_execute(
module_name="mast",
function_name="get_metadata",
params={"query_type": "<query_type>"},
)
get_product_list
Call via MCP
astroquery_execute(
module_name="mast",
function_name="get_product_list",
params={},
)
- ObservationsClass.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. Note that obsid is NOT the same as obs_id, and inputting obs_id values will result in an error. See column documentation here.
To return unique data products, use
Observations.get_unique_product_list.
get_product_list_async
Call via MCP
astroquery_execute(
module_name="mast",
function_name="get_product_list_async",
params={"observations": "<observations>"},
)
- ObservationsClass.get_product_list_async(observations)
Given a “Product Group Id” (column name obsid) returns a list of associated data products. Note that obsid is NOT the same as obs_id, and inputting obs_id values will result in an error. See column documentation here.
To return unique data products, use
Observations.get_unique_product_list.
get_unique_product_list
Call via MCP
astroquery_execute(
module_name="mast",
function_name="get_unique_product_list",
params={"observations": "<observations>"},
)
- ObservationsClass.get_unique_product_list(observations)
Given a “Product Group Id” (column name obsid), returns a list of associated data products with unique dataURIs. Note that obsid is NOT the same as obs_id, and inputting obs_id values will result in an error. See column documentation here.
list_missions
Call via MCP
astroquery_execute(
module_name="mast",
function_name="list_missions",
params={},
)
- ObservationsClass.list_missions()
Lists data missions archived by MAST and available through
astroquery.mast.- Returns:
response – List of available missions.
- Return type:
login
Call via MCP
astroquery_execute(
module_name="mast",
function_name="login",
params={},
)
- ObservationsClass.login(token=None, store_token=False, reenter_token=False)
Log into the MAST portal.
- Parameters:
token (
string, optional) – 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_TOKENstore_token (
bool, optional) – Default False. If true, MAST token will be stored securely in your keyring.reenter_token (
bool, 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
Call via MCP
astroquery_execute(
module_name="mast",
function_name="logout",
params={},
)
- ObservationsClass.logout()
Log out of current MAST session.
query_criteria
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_criteria",
params={},
)
- ObservationsClass.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 specific page of results.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 STScI Archive Name Translation Application (SANTA) for more information. Default is None.**criteria – Criteria to apply. At least one non-positional criteria must be supplied. Valid criteria are coordinates, objectname, radius (as in
query_regionandquery_object), and all observation fields returned by theget_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
- Return type:
A `~astropy.table.Tableobject.`
query_criteria_async
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_criteria_async",
params={},
)
- ObservationsClass.query_criteria_async(*, pagesize=None, page=None, resolver=None, **criteria)
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 specific page of results.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 STScI Archive Name Translation Application (SANTA) for more information. Default is None.**criteria – Criteria to apply. At least one non-positional criteria must be supplied. Valid criteria are coordinates, objectname, radius (as in
query_regionandquery_object), and all observation fields returned by theget_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
- Return type:
listofResponse
query_criteria_count
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_criteria_count",
params={},
)
- ObservationsClass.query_criteria_count(*, pagesize=None, page=None, resolver=None, **criteria)
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 specific page of results.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 STScI Archive Name Translation Application (SANTA) for more information. Default is None.**criteria – Criteria to apply. At least one non-positional criterion must be supplied. Valid criteria are coordinates, objectname, radius (as in
query_regionandquery_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
- Return type:
query_object
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_object",
params={},
)
- ObservationsClass.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 (
strorQuantityobject, optional) – Default 0.2 degrees. The string must be parsable byAngle. The appropriateQuantityobject fromunitsmay 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.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 STScI Archive Name Translation Application (SANTA) for more information. Default is None.
- Returns:
table
- Return type:
A `~astropy.table.Tableobject.`
query_object_async
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_object_async",
params={"objectname": "<objectname>"},
)
- ObservationsClass.query_object_async(objectname, *, radius=<Quantity 0.2 deg>, pagesize=None, page=None, resolver=None)
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 (
strorQuantityobject, optional) – Default 0.2 degrees. The string must be parsable byAngle. The appropriateQuantityobject fromunitsmay 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.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 STScI Archive Name Translation Application (SANTA) for more information. Default is None.
- Returns:
response
- Return type:
listofResponse
query_object_count
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_object_count",
params={"objectname": "<objectname>"},
)
- ObservationsClass.query_object_count(objectname, *, radius=<Quantity 0.2 deg>, pagesize=None, page=None, resolver=None)
Given an object name, returns the number of MAST observations.
- Parameters:
objectname (
str) – The name of the target around which to search.radius (
strorQuantityobject, optional) – The string must be parsable byAngle. The appropriateQuantityobject fromunitsmay 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 specific page of results.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 STScI Archive Name Translation Application (SANTA) for more information. Default is None.
- Returns:
response
- Return type:
query_region
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_region",
params={},
)
- ObservationsClass.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 (
strorcoordinatesobject) – The target around which to search. It may be specified as a string or as the appropriatecoordinatesobject.radius (
strorQuantityobject, optional) – Default 0.2 degrees. The string must be parsable byAngle. The appropriateQuantityobject fromunitsmay 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
- Return type:
A `~astropy.table.Tableobject.`
query_region_async
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_region_async",
params={"coordinates": "<coordinates>"},
)
- ObservationsClass.query_region_async(coordinates, *, radius=<Quantity 0.2 deg>, pagesize=None, page=None)
Given a sky position and radius, returns a list of MAST observations. See column documentation here.
- Parameters:
coordinates (
strorcoordinatesobject) – The target around which to search. It may be specified as a string or as the appropriatecoordinatesobject.radius (
strorQuantityobject, optional) – Default 0.2 degrees. The string must be parsable byAngle. The appropriateQuantityobject fromunitsmay 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
- Return type:
listofResponse
query_region_count
Call via MCP
astroquery_execute(
module_name="mast",
function_name="query_region_count",
params={"coordinates": "<coordinates>"},
)
- ObservationsClass.query_region_count(coordinates, *, radius=<Quantity 0.2 deg>, pagesize=None, page=None)
Given a sky position and radius, returns the number of MAST observations in that region.
- Parameters:
coordinates (
strorcoordinatesobject) – The target around which to search. It may be specified as a string or as the appropriatecoordinatesobject.radius (
strorQuantityobject, optional) – The string must be parsable byAngle. The appropriateQuantityobject fromunitsmay 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
- Return type:
reset_cache_location
Call via MCP
astroquery_execute(
module_name="mast",
function_name="reset_cache_location",
params={},
)
- ObservationsClass.reset_cache_location()
Resets the cache location to the default astropy cache
resolve_object
Call via MCP
astroquery_execute(
module_name="mast",
function_name="resolve_object",
params={"objectname": "<objectname>"},
)
- ObservationsClass.resolve_object(objectname, *, resolver=None, resolve_all=False)
Resolves an object name to a position on the sky.
- Parameters:
objectname (
str) – Name of astronomical object to resolve.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 STScI Archive Name Translation Application (SANTA) for more information. Ifresolve_allis True, this parameter will be ignored. Default is None.resolve_all (
bool, optional) – 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:
response – If
resolve_allis False, returns aSkyCoordobject with the resolved coordinates. Ifresolve_allis True, returns a dictionary where the keys are the resolver names and the values areSkyCoordobjects with the resolved coordinates.- Return type: