MastClass

class astroquery.mast.MastClass(mast_token=None)[source]

Bases: astroquery.mast.core.MastQueryWithLogin

MAST query class.

Class that allows direct programatic access to the MAST Portal, more flexible but less user friendly than ObservationsClass.

Methods Summary

__call__(*args, **kwargs)

init a fresh copy of self

authenticated()

disable_cloud_dataset()

Disables downloading public files from S3 instead of MAST

disable_s3_hst_dataset()

Deprecated since version v0.3.9.

enable_cloud_dataset([provider, profile, …])

Enable downloading public files from S3 instead of MAST.

enable_s3_hst_dataset()

Deprecated since version v0.3.9.

get_token()

Deprecated since version v0.3.9.

login([token, store_token, reenter_token])

Log into the MAST portal.

logout()

Log out of current MAST session.

resolve_object(objectname)

Resolves an object name to a position on the sky.

service_request(*args, **kwargs)

Queries the service and returns a table object.

service_request_async(service, params[, …])

Given a Mashup service and parameters, builds and excecutes a Mashup query.

session_info([silent, 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

disable_s3_hst_dataset()

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.

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.

enable_s3_hst_dataset()

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.

get_token()

Deprecated since version v0.3.9: The get_token function is deprecated, session token is now the token used for login.

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://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_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()

Log out of current MAST session.

resolve_object(objectname)

Resolves an object name to a position on the sky.

Parameters

objectname : str

Name of astronomical object to resolve.

Returns

response : SkyCoord

The sky position of the given object.

service_request(*args, **kwargs)

Queries the service and returns a table object.

Given a Mashup service and parameters, builds and excecutes a Mashup query. See documentation here for information about how to build a Mashup request.

Parameters

service : str

The Mashup service to query.

params : dict

JSON object containing service parameters.

pagesize : int, optional

Default None. Can be used to override the default pagesize (set in configs) for 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.

**kwargs :

See MashupRequest properties here for additional keyword arguments.

Returns

table : A Table object.

service_request_async(service, params, pagesize=None, page=None, **kwargs)[source]

Given a Mashup service and parameters, builds and excecutes a Mashup query. See documentation here for information about how to build a Mashup request.

Parameters

service : str

The Mashup service to query.

params : dict

JSON object containing service parameters.

pagesize : int, optional

Default None. Can be used to override the default pagesize (set in configs) for 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.

**kwargs :

See MashupRequest properties here for additional keyword arguments.

Returns

response : list of Response

session_info(silent=None, verbose=None)

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

Parameters

silent :

Deprecated. Use verbose instead.

verbose : bool, optional

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

Returns

response : dict