Utility Modules

These provide low-level functionality for exovetter.

exovetter.const Module

Constants and units for exoplanet vetting.

Variables

bjd	BJD
bkjd	BKJD
btjd	BTJD
bet	Barycentric Emphemeris Time (BET)
ppk	PPK
ppm	PPM
frac_amp	Frac amp
string_to_offset	Supported Time Offset Keywords

exovetter.model Module

The exovetter.model module handles transit models for the modshift vetter.

Available models:

• Boxcar

• Trapezoid (to be added in the future)

Developer notes

For each model type, create 2 functions:

1. create_<modelname>_model_for_tce: Takes a TCE as input.

2. create_<modelname>: Takes more fundamental times (e.g., numpy arrays, floats).

Functions

create_box_model_for_tce(tce, times, time_offset)	Create boxcar model for a given TCE.
create_box_model(times, period, epoch, ...)	Create boxcar model.

exovetter.lightkurve_utils Module

Functions to handle compatibility with lightkurve.

Functions

unpack_lk_version(lightcurve, flux_name)	Code to get time, flux and time_format from lightcurve object independent of v1 or v2 of the package.
unpack_tpf(tpf, name)	Parameters:

exovetter.trapezoid_fit Module

Module to perform a trapezoid model fit to flux time series data.

Originally written by Christopher Burke [1].

References

[1]

Kostov, V. B., Mullaly, S. E., Quintana, E. V. et al. 2019, AJ, 157, 3 (arXiv:1901.07459)

Functions

phase_data(t, period, t_zero)	Phase the data at period per and centered at to inputs given.
trapezoid_vectors(t, depth, big_t, little_t)	Trapezoid shape, in the form of vectors, for model.

Classes

TrapezoidFitParameters(cadlen[, samplen, ...])	Class to handle the parameters of the trapezoid fit algorithms.
TrapezoidOriginalEstimates([period, epoch, ...])	Class to handle the original parameter estimations.
TrapezoidPlanetEstimates([u1, u2, period, ...])	Class to handle estimating a planet's model based upon the trapezoid fit solution.
TrapezoidFit(time_series, data_series, ...)	Class to handle trapezoid fits.

exovetter.utils Module

Utility functions.

Functions

sine(x, order[, period])	Sine function for SWEET vetter.
estimate_scatter(flux)	Estimate the typical scatter in a lightcurve.
mark_transit_cadences(time, period_days, ...)	Create a logical array indicating which cadences are affected by a transit.
median_detrend(flux, nPoints)	Quick and dirty median smooth function.
plateau(array, threshold)	Find plateaus in an array, i.e continuous regions that exceed threshold.
set_median_flux_to_zero(flux)	Set median flux to zero.
set_median_flux_to_one(flux)	Set median flux to one.
sigmaClip(y, nSigma[, maxIter, initialClip])	Iteratively find and remove outliers
get_mast_tce(name[, catalogs])	Populate a TCE object using the mast database
compute_phases(time, period, epoch[, offset])	Calculate phases.
first_epoch(epoch, period, lc)	Returns epoch of the first time in a lc file.

Classes

WqedLSF(x, y[, s, order, func])

Least squares fit to an analytic function based on lsf.c in Wqed, which in turn was based on Bevington and Robinson.