CubeFactory

class astrocut.CubeFactory[source]

Bases: object

Class for creating image cubes.

This class emcompasses all of the cube making functionality. In the current version this means creating image cubes fits files from TESS full frame image sets. Future versions will include more generalized cubing functionality.

Methods Summary

make_cube(self, file_list[, cube_file, …])

Turns a list of fits image files into one large data-cube.

Methods Documentation

make_cube(self, file_list, cube_file='img-cube.fits', sector=None, verbose=True)[source]

Turns a list of fits image files into one large data-cube. Input images must all have the same footprint and resolution. The resulting datacube is transposed for quicker cutouts. This function can take some time to run and requires enough memory to hold the entire cube in memory. (For full TESS sectors this is about 40 GB)

Parameters
file_listarray

The list of fits image files to cube. Assumed to have the format of a TESS FFI: - A primary HDU consisting only of a primary header - An image HDU containing the image - A second image HDU containing the uncertainty image

cube_filestring

Optional. The filename/path to save the output cube in.

sectorint

Optional. TESS sector to add as header keyword (not present in FFI files).

verbosebool

Optional. If true intermediate information is printed.

Returns
response: string or None

If successful, returns the path to the cube fits file, if unsuccessful returns None.