TOI

class stellarphot.io.TOI(*, tic_id: int, coord: Annotated[SkyCoord, AstropyValidator], depth_ppt: float, depth_error_ppt: float, duration: Annotated[Quantity, _UnitQuantTypePydanticAnnotation, WithPhysicalType(physical_type=time)], duration_error: Annotated[Quantity, _UnitQuantTypePydanticAnnotation, WithPhysicalType(physical_type=time)], epoch: Annotated[Time, AstropyValidator], epoch_error: Annotated[Quantity, _UnitQuantTypePydanticAnnotation, WithPhysicalType(physical_type=time)], period: Annotated[Quantity, _UnitQuantTypePydanticAnnotation, WithPhysicalType(physical_type=time)], period_error: Annotated[Quantity, _UnitQuantTypePydanticAnnotation, WithPhysicalType(physical_type=time)], tess_mag: float, tess_mag_error: float)

Bases: BaseModel

Represent a TOI from the ExoFOP database.

Parameters:

tic_idint

The TIC ID of the target.

coordastropy.coordinates.SkyCoord

The coordinates of the target.

depth_pptfloat

The depth of the transit in parts per thousand.

depth_error_pptfloat

The error in the depth of the transit in parts per thousand.

durationastropy.units.Quantity

The duration of the transit; must have units of time.

duration_errorastropy.units.Quantity

The error in the duration of the transit; must have units of time.

epochastropy.time.Time

The epoch of the transit.

epoch_errorastropy.units.Quantity

The error in the epoch of the transit; must have units of time.

periodastropy.units.Quantity

The period of the transit; must have units of time.

period_errorastropy.units.Quantity

The error in the period of the transit; must have units of time.

tess_magfloat

The TESS magnitude of the target.

tess_mag_errorfloat

The error in the TESS magnitude of the target.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes Summary

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Summary

from_tic_id(tic_id)	Create a TOI object from a numerical TIC ID number.
transit_time_for_observation(obs_times)	Calculate the transit time for a set of observation times.

Attributes Documentation

model_config = {'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Documentation

classmethod from_tic_id(tic_id)

Create a TOI object from a numerical TIC ID number. This will be obtained from ExoFOP-TESS and the TESS Input Catalog (TIC) at MAST.

transit_time_for_observation(obs_times)

Calculate the transit time for a set of observation times.

Parameters:

obs_timesastropy.time.Time

The times of the observations.

Returns:

astropy.time.Time

The transit times for the observations.