TessCubeCutout

class astrocut.TessCubeCutout(input_files: List[Union[str, Path, S3Path]], 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', threads: Union[int, Literal['auto']] = 1, product: str = 'SPOC', verbose: bool = False)[source]

Bases: CubeCutout

Class for creating cutouts from TESS full frame image cubes.

Parameters

input_fileslist: List of input image files.
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’.
threadsint | ‘auto’: The number of threads to use for making the cutouts. If ‘auto’, the number of threads will be set to the number of available CPUs.
productstr: The product type to make the cutouts from. Can either be ‘SPOC’ or ‘TICA’ (default is ‘SPOC’).
verbosebool: If True, log messages are printed to the console.

Attributes

cutouts_by_filedict: Dictionary where each key is an input cube filename and its corresponding value is the resulting cutout as a CubeCutoutInstance object.
cutoutslist: Return a list of cutouts as CubeCutout.CubeCutoutInstance objects.
tpf_cutouts_by_filedict: Dictionary where each key is an input cube filename and its corresponding value is the resulting cutout target pixel file object.
tpf_cutoutslist: Return the cutouts as a list of astropy.io.fits.HDUList target pixel file objects.

Methods

write_as_tpf(output_dir, output_file)

Write the cutouts to target pixel files.

Attributes Summary

`cutouts`	Return a list of cutouts as `CubeCutout.CubeCutoutInstance` objects.
`tpf_cutouts`	Return the cutouts as a list of `astropy.io.fits.HDUList` target pixel file objects.

Methods Summary

`cutout`()	Generate cutouts from a list of input cube files.
`write_as_tpf`([output_dir, output_file])	Write the cutouts to disk as target pixel files.

Attributes Documentation

cutouts: Return a list of cutouts as CubeCutout.CubeCutoutInstance objects.

tpf_cutouts: Return the cutouts as a list of astropy.io.fits.HDUList target pixel file objects.

Methods Documentation

cutout()

Generate cutouts from a list of input cube files.

Returns

write_as_tpf(output_dir: Union[str, Path] = '.', output_file: str = None)[source]

Write the cutouts to disk as target pixel files.

Parameters

output_dirstr | Path: The output directory where the cutout files will be saved.
output_filestr: The output filename. If not provided or more than one cutout is created, the filename will be generated based on the input filename. This parameter is included so that CubeCutout is backwards compatible with CutoutFactory.cube_cut.

Returns