`ramjet.photometric_database.tess_ffi_light_curve`¶

Code to for a class to represent a TESS FFI light curve.

Module Contents¶

Classes¶

`TessFfiColumnName`	An enum to represent the column names of the TESS FFI data.
`TessFfiPickleIndex`	An enum for accessing Brian Powell’s FFI pickle data with understandable indexes.
`TessFfiLightCurve`	A class to for a class to represent a TESS FFI light curve.

class TessFfiColumnName[source]¶

Bases: enum.Enum

An enum to represent the column names of the TESS FFI data.

TIME__BTJD = time__btjd¶

CORRECTED_FLUX = corrected_flux¶

RAW_FLUX = raw_flux¶

FLUX_ERROR = flux_error¶

class TessFfiPickleIndex[source]¶

Bases: enum.Enum

An enum for accessing Brian Powell’s FFI pickle data with understandable indexes.

TIC_ID = 0¶

RA = 1¶

DEC = 2¶

TESS_MAGNITUDE = 3¶

CAMERA = 4¶

CHIP = 5¶

TIME__BTJD = 6¶

RAW_FLUX = 7¶

CORRECTED_FLUX = 8¶

PCA_FLUX = 9¶

FLUX_ERROR = 10¶

QUALITY = 11¶

class TessFfiLightCurve[source]¶

Bases: ramjet.photometric_database.tess_light_curve.TessLightCurve

A class to for a class to represent a TESS FFI light curve.

mast_tess_data_interface¶

__init__(self)[source]¶: Initialize self. See help(type(self)) for accurate signature.

classmethod from_path(cls, path: Path, column_names_to_load: Union[List[TessFfiColumnName], None] = None)[source]¶

Creates an FFI TESS light curve from a path to one of Brian Powell’s pickle files.

Parameters:	path – The path to the pickle file to load. column_names_to_load – The FFI light curve columns to load from the pickle file. By default, all will be loaded. Selecting specific ones may speed the process when loading many light curves.
Returns:	The light curve.

static get_tic_id_and_sector_from_file_path(path: Union[Path, str])[source]¶

Gets the TIC ID and sector from commonly encountered file name patterns.

Parameters:	path – The path of the file to extract the TIC ID and sector.
Returns:	The TIC ID and sector. The sector might be omitted (as None).

static get_floor_magnitude_from_file_path(file_path: Union[Path, str])[source]¶

Gets the floor magnitude from the FFI file path.

Parameters:	file_path – The path of the file to extract the magnitude.
Returns:	The magnitude floored.

static get_magnitude_from_file(file_path: Union[Path, str])[source]¶

Loads the magnitude from the file.

Parameters:	file_path – The path to the file.
Returns:	The magnitude of the target.

classmethod load_fluxes_and_times_from_pickle_file(cls, file_path: Union[Path, str], flux_column_name: TessFfiColumnName = TessFfiColumnName.CORRECTED_FLUX)[source]¶

Loads the fluxes and times from one of Brian Powell’s FFI pickle files.

Parameters:	file_path – The path to the pickle file to load. flux_column_name – The flux type to load.
Returns:	The fluxes and the times.

classmethod load_fluxes_flux_errors_and_times_from_pickle_file(cls, file_path: Union[Path, str], flux_column_name: TessFfiColumnName = TessFfiColumnName.CORRECTED_FLUX)[source]¶

Loads the fluxes, flux errors, and times from one of Brian Powell’s FFI pickle files.

Parameters:	file_path – The path to the pickle file to load. flux_column_name – The flux type to load.
Returns:	The fluxes, flux errors, and times.

ramjet.photometric_database.tess_ffi_light_curve¶

Module Contents¶

Classes¶

`ramjet.photometric_database.tess_ffi_light_curve`¶