ramjet.data_interface.tess_ffi_data_interface

Code for interfacing with Brian Powell’s TESS full frame image (FFI) data.

Module Contents

Classes

FfiDataIndexes() An enum for accessing Brian Powell’s FFI pickle data with understandable indexes.
TessFfiDataInterface(lightcurve_root_directory_path: Path = Path(‘data/tess_ffi_lightcurves’), database_path: Union[Path, str] = Path(‘data/metadatabase.sqlite3’)) A class for interfacing with Brian Powell’s TESS full frame image (FFI) data.
class FfiDataIndexes[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 TessFfiDataInterface(lightcurve_root_directory_path: Path = Path('data/tess_ffi_lightcurves'), database_path: Union[Path, str] = Path('data/metadatabase.sqlite3'))[source]

A class for interfacing with Brian Powell’s TESS full frame image (FFI) data.

__init__(self, lightcurve_root_directory_path: Path = Path('data/tess_ffi_lightcurves'), database_path: Union[Path, str] = Path('data/metadatabase.sqlite3'))[source]

Initialize self. See help(type(self)) for accurate signature.

static load_fluxes_and_times_from_pickle_file(file_path: Union[Path, str], flux_type_index: FfiDataIndexes = FfiDataIndexes.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_type_index – The flux type to load.
Returns:

The fluxes and the times.
static load_fluxes_flux_errors_and_times_from_pickle_file(file_path: Union[Path, str], flux_type_index: FfiDataIndexes = FfiDataIndexes.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_type_index – The flux type to load.
Returns:

The fluxes and the times.
static get_tic_id_and_sector_from_file_path(file_path: Union[Path, str])[source]

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

Parameters:file_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.