TessFootprintCutout

class astrocut.TessFootprintCutout(coordinates: Union[SkyCoord, str], cutout_size: Union[int, ndarray, Quantity, List[int], Tuple[int]] = 25, fill_value: Union[int, float] = nan, limit_rounding_method: str = 'round', sequence: Optional[Union[int, List[int]]] = None, product: str = 'SPOC', verbose: bool = False)

Bases: FootprintCutout

Class for generating cutouts from TESS Full Frame Images (FFIs) hosted on the cloud based on the footprint of the cutout.

Parameters

coordinatesstr | SkyCoord

Coordinates of the center of the cutout.

cutout_sizeint | array | list | tuple | Quantity

Size of the cutout array.

fill_valueint | float

Value to fill the cutout with if the cutout is outside the image.

limit_rounding_methodstr

Method to use for rounding the cutout limits. Options are ‘round’, ‘ceil’, and ‘floor’.

sequenceint | list | None

Default None. Sequence(s) from which to generate cutouts. Can provide a single sequence number as an int or a list of sequence numbers. If not specified, cutouts will be generated from all sequences that contain the cutout. For the TESS mission, this parameter corresponds to sectors.

productstr, optional

Default ‘SPOC’. The product type to make the cutouts from.

verbosebool

If True, log messages are printed to the console.

Attributes

tess_cube_cutoutTessCubeCutout

Object containing the cutouts from the TESS cubes.

cutouts_by_filedict

Dictionary where each key is an input cube S3 URI and its corresponding value is the resulting cutout as a CubeCutoutInstance object.

cutoutslist

List of cutout objects.

tpf_cutouts_by_filedict

Dictionary where each key is an input cube S3 URI and its corresponding value is the resulting cutout target pixel file object.

tpf_cutoutslist

List of cutout target pixel file objects.

Methods

cutout()	Generate the cutouts from the cloud FFIs that intersect the cutout footprint.
write_as_tpf(output_dir)	Write the cutouts as Target Pixel Files (TPFs) to the specified directory.

Methods Summary

cutout()	Generate the cutouts from the cloud FFIs that intersect the cutout footprint.
write_as_tpf([output_dir])	Write the cutouts to disk as target pixel files.

Methods Documentation

cutout()

Generate the cutouts from the cloud FFIs that intersect the cutout footprint.

Raises

InvalidQueryError

If no files are found for the given sequences. If the given coordinates are not found within the specified sequence(s).

write_as_tpf(output_dir: Union[str, Path] = '.') → List[str]

Write the cutouts to disk as target pixel files.

Parameters

output_dirstr | Path

The output directory where the cutout files will be saved.

Returns

cutout_pathslist

List of file paths to cutout target pixel files.