MastClass

class astroquery.mast.MastClass(mast_token=None)

Bases: MastQueryWithLogin

MAST query class.

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

Attributes Summary

cache_location

Methods Summary

__call__(*args, **kwargs)	init a fresh copy of self
authenticated()
clear_cache()	Removes all cache files.
disable_cloud_dataset()	Disables downloading public files from S3 instead of MAST
enable_cloud_dataset([provider, profile, ...])	Enable downloading public files from S3 instead of MAST.
login([token, store_token, reenter_token])	Log into the MAST portal.
logout()	Log out of current MAST session.
mast_query(service[, columns])	Given a Mashup service and parameters as keyword arguments, builds and excecutes a Mashup query.
reset_cache_location()	Resets the cache location to the default astropy cache
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 executes a Mashup query.
session_info([verbose])	Displays information about current MAST user, and returns user info dictionary.

Attributes Documentation

cache_location

Methods Documentation

__call__(*args, **kwargs)

init a fresh copy of self

authenticated()

clear_cache()

Removes all cache files.

disable_cloud_dataset()

Disables downloading public files from S3 instead of MAST

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.

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.

mast_query(service, columns=None, **kwargs)

Given a Mashup service and parameters as keyword arguments, builds and excecutes a Mashup query.

Parameters:

servicestr

The Mashup service to query.

columnsstr, optional

Specifies the columns to be returned as a comma-separated list, e.g. “ID, ra, dec”.

**kwargs

Service-specific parameters and MashupRequest properties. See the service documentation and the MashupRequest Class Reference for valid keyword arguments.

Returns:

responseTable

reset_cache_location()

Resets the cache location to the default astropy cache

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.

service_request(*args, **kwargs)

Queries the service and returns a table object.

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

Parameters:

servicestr

The Mashup service to query.

paramsdict

JSON object containing service parameters.

pagesizeint, 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.

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

See MashupRequest properties here for additional keyword arguments.

Returns:

tableA Table object.

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

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

Parameters:

servicestr

The Mashup service to query.

paramsdict

JSON object containing service parameters.

pagesizeint, 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.

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

See MashupRequest properties here for additional keyword arguments.

Returns:

responselist of Response

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