ramjet.data_interface.tess_toi_data_interface¶

Classes¶

class ToiColumns[source]¶

Bases: enum.Enum

An enum for the names of the TOI columns for Pandas data frames.

tic_id = TIC ID¶

disposition = Disposition¶

transit_epoch__bjd = Transit epoch (BJD)¶

transit_period__days = Transit period (days)¶

transit_duration = Transit duration (hours)¶

sector = Sector¶

class ExofopDisposition[source]¶

Bases: enum.Enum

An enum for the ExoFOP dispositions.

CONFIRMED_PLANET = CP¶

KEPLER_CONFIRMED_PLANET = KP¶

PLANET_CANDIDATE = PC¶

FALSE_POSITIVE = FP¶

class TessToiDataInterface(data_directory='data/tess_toi')[source]¶

A data interface for working with the TESS table of objects of interest.

toi_dispositions¶

The TOI dispositions data frame property. Will load as an instance attribute on first access. Updates from ExoFOP on first access.

Returns:	The TOI dispositions data frame.

ctoi_dispositions¶

The CTOI dispositions data frame property. Will load as an instance attribute on first access. Updates from ExoFOP on first access.

Returns:	The CTOI dispositions data frame.

__init__(self, data_directory='data/tess_toi')[source]¶

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

update_toi_dispositions_file(self)[source]¶

Downloads the latest TOI dispositions file.

update_ctoi_dispositions_file(self)[source]¶

Downloads the latest CTOI dispositions file.

load_toi_dispositions_in_project_format(self)[source]¶

Loads the ExoFOP TOI table information from CSV to a data frame using a project consistent naming scheme.

Returns:	The data frame of the TOI dispositions table.

load_ctoi_dispositions_in_project_format(self)[source]¶

Loads the ExoFOP CTOI table information from CSV to a data frame using a project consistent naming scheme.

Returns:	The data frame of the CTOI dispositions table.

retrieve_exofop_toi_and_ctoi_planet_disposition_for_tic_id(self, tic_id: int)[source]¶

Retrieves the ExoFOP disposition information for a given TIC ID from <https://exofop.ipac.caltech.edu/tess/>`_.

Parameters:	tic_id – The TIC ID to get available data for.
Returns:	The disposition data frame.

has_any_exofop_dispositions_for_tic_id(self, tic_id: int)[source]¶

Returns whether or not any dispositions exist for this TIC ID.

Parameters:	tic_id – The TIC ID to check.
Returns:	True if there are dispositions, False if none.

print_exofop_toi_and_ctoi_planet_dispositions_for_tic_target(self, tic_id)[source]¶

Prints all ExoFOP disposition information for a given TESS target.

Parameters:	tic_id – The TIC target to for.

download_exofop_toi_lightcurves_to_directory(self, directory: Path)[source]¶

Downloads the ExoFOP database lightcurve files to the given directory.

Parameters:	directory – The directory to download the lightcurves to. Defaults to the data interface directory.

tess_toi_data_interface¶