HapcutClass¶
- class astroquery.mast.HapcutClass[source]¶
Bases:
MastQueryWithLogin
MAST Hubble Advanced Product (HAP) cutout query class.
Class for accessing HAP image cutouts.
Attributes Summary
Methods Summary
__call__
(*args, **kwargs)init a fresh copy of self
Removes all cache files.
download_cutouts
(coordinates, *[, size, ...])Download cutout images around the given coordinates with indicated size.
enable_cloud_dataset
([provider, profile, ...])get_cutouts
(coordinates, *[, size])Get cutout image(s) around the given coordinates with indicated size, and return them as a list of
HDUList
objects.login
([token, store_token, reenter_token])Log into the MAST portal.
logout
()Log out of current MAST session.
Resets the cache location to the default astropy cache
resolve_object
(objectname)Resolves an object name to a position on the sky.
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()¶
Deprecated since version v0.4.8: This function is non-operational and will be removed in a future release.
Disables downloading public files from S3 instead of MAST.
- download_cutouts(coordinates, *, size=5, path='.', inflate=True, verbose=False)[source]¶
Download cutout images around the given coordinates with indicated size.
- Parameters:
- coordinatesstr or
astropy.coordinates
object The target around which to search. It may be specified as a string or as the appropriate
astropy.coordinates
object.- sizeint, array-like,
Quantity
Optional, default 5 pixels. The size of the cutout array. If
size
is a scalar number or a scalarQuantity
, then a square cutout ofsize
will be created. Ifsize
has two elements, they should be in(ny, nx)
order. Scalar numbers insize
are assumed to be in units of pixels.Quantity
objects must be in pixel or angular units.- pathstr
Optional. The directory in which the cutouts will be saved. Defaults to current directory.
- inflatebool
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.
- coordinatesstr or
- Returns:
- response
Table
- response
- enable_cloud_dataset(provider='AWS', profile=None, verbose=True)¶
Deprecated since version v0.4.8: This function is non-operational and will be removed in a future release.
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.
- get_cutouts(coordinates, *, size=5)[source]¶
Get cutout image(s) around the given coordinates with indicated size, and return them as a list of
HDUList
objects.- Parameters:
- coordinatesstr or
astropy.coordinates
object The target around which to search. It may be specified as a string or as the appropriate
astropy.coordinates
object.- sizeint, array-like,
Quantity
Optional, default 5 pixels. The size of the cutout array. If
size
is a scalar number or a scalarQuantity
, then a square cutout ofsize
will be created. Ifsize
has two elements, they should be in(ny, nx)
order. Scalar numbers insize
are assumed to be in units of pixels.Quantity
objects must be in pixel or angular units.
- coordinatesstr or
- Returns:
- responseA list of
HDUList
objects.
- responseA list of
- 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://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_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.
- 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:
- response
SkyCoord
The sky position of the given object.
- 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