BaseVetter

class exovetter.vetters.BaseVetter(**kwargs)[source]

Bases: ABC

Base class for vetters.

Each vetting test should be a subclass of this class.

Parameters:
kwargsdict

Store the configuration parameters common to all Threshold Crossing Events (TCEs). For example, for the Odd-even test, it might specify the significance of the depth difference that causes a TCE to fail.

Methods Summary

name()

plot(tce, lightcurve)

Generate a diagnostic plot.

run(tce, lightcurve)

Run the vetter on the specified Threshold Crossing Event (TCE) and lightcurve to obtain metric.

Methods Documentation

name()[source]
plot(tce, lightcurve)[source]

Generate a diagnostic plot.

Parameters:
tce, lightcurve

See run().

abstract run(tce, lightcurve)[source]

Run the vetter on the specified Threshold Crossing Event (TCE) and lightcurve to obtain metric.

Parameters:
tceTce

TCE.

lightcurveobj

lightkurve object that contains the detrended lightcurve’s time and flux arrays.

Returns:
resultdict

A dictionary of metric values.