TesscutClass

class astroquery.mast.TesscutClass

Bases: astroquery.mast.core.MastQueryWithLogin

MAST TESS FFI cutout query class.

Class for accessing TESS full-frame image cutouts.

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.
download_cutouts([coordinates, size, …])	Download cutout target pixel file(s) around the given coordinates with indicated size.
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_cutouts([coordinates, size, sector, …])	Get cutout target pixel file(s) around the given coordinates with indicated size, and return them as a list of HDUList objects.
get_sectors([coordinates, radius, objectname])	Get a list of the TESS data sectors whose footprints intersect with the given search area.
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.
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.

download_cutouts(coordinates=None, size=5, sector=None, path='.', inflate=True, objectname=None)

Download cutout target pixel file(s) around the given coordinates with indicated size.

Parameters

coordinates : str or astropy.coordinates object, optional

The target around which to search. It may be specified as a string or as the appropriate astropy.coordinates object. One and only one of coordinates and objectname must be supplied.

size : int, array-like, Quantity

Optional, default 5 pixels. The size of the cutout array. If size is a scalar number or a scalar Quantity, then a square cutout of size will be created. If size has two elements, they should be in (ny, nx) order. Scalar numbers in size are assumed to be in units of pixels. Quantity objects must be in pixel or angular units.

sector : int

Optional. The TESS sector to return the cutout from. If not supplied, cutouts from all available sectors on which the coordinate appears will be returned.

path : str

Optional. The directory in which the cutouts will be saved. Defaults to current directory.

inflate : bool

Optional, default True. Cutout target pixel files are returned from the server in a zip file, by default they will be inflated and the zip will be removed. Set inflate to false to stop before the inflate step.

objectname : str, optional

The target around which to search, by name (objectname=”M104”) or TIC ID (objectname=”TIC 141914082”). One and only one of coordinates and objectname must be supplied.

Returns

response : Table

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_cutouts(coordinates=None, size=5, sector=None, objectname=None)

Get cutout target pixel file(s) around the given coordinates with indicated size, and return them as a list of HDUList objects.

Parameters

coordinates : str or astropy.coordinates object, optional

The target around which to search. It may be specified as a string or as the appropriate astropy.coordinates object. One and only one of coordinates and objectname must be supplied.

size : int, array-like, Quantity

Optional, default 5 pixels. The size of the cutout array. If size is a scalar number or a scalar Quantity, then a square cutout of size will be created. If size has two elements, they should be in (ny, nx) order. Scalar numbers in size are assumed to be in units of pixels. Quantity objects must be in pixel or angular units.

sector : int

Optional. The TESS sector to return the cutout from. If not supplied, cutouts from all available sectors on which the coordinate appears will be returned.

objectname : str, optional

The target around which to search, by name (objectname=”M104”) or TIC ID (objectname=”TIC 141914082”). One and only one of coordinates and objectname must be supplied.

Returns

response : A list of HDUList objects.

get_sectors(coordinates=None, radius=<Quantity 0.2 deg>, objectname=None)

Get a list of the TESS data sectors whose footprints intersect with the given search area.

Parameters

coordinates : str or astropy.coordinates object, optional

The target around which to search. It may be specified as a string or as the appropriate astropy.coordinates object. One and only one of coordinates and objectname must be supplied.

radius : str, float, or Quantity object, optional

Default 0.2 degrees. If supplied as a float degrees is the assumed unit. The string must be parsable by Angle. The appropriate Quantity object from astropy.units may also be used.

objectname : str, optional

The target around which to search, by name (objectname=”M104”) or TIC ID (objectname=”TIC 141914082”). One and only one of coordinates and objectname must be supplied.

Returns

response : Table

Sector/camera/chip information for given coordinates/raduis.

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.

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