Sweet
- class exovetter.vetters.Sweet(lc_name='flux', threshold_sigma=3)[source]
Bases:
BaseVetter
SWEET Vetter
- Parameters:
- lc_namestr
Name of the flux array in the
lightkurve
object.- threshold_sigmafloat
Threshold for comparing signal to transit period.
- Attributes:
- tcetce object
tce object is a dictionary that contains information about the tce to vet, like period, epoch, duration, depth.
- lclightkurve object
lightkurve object with the time and flux of the data to use for vetting.
- metricsdict
SWEET result dictionary populated by
run()
.
Methods Summary
plot
()Generate a diagnostic plot.
run
(tce, lightcurve[, plot])Runs sweet.sweet and sweet.construct_message to populate the vetter object.
Methods Documentation
- run(tce, lightcurve, plot=False)[source]
Runs sweet.sweet and sweet.construct_message to populate the vetter object.
- Parameters:
- tcetce object
tce object is a dictionary that contains information about the tce to vet, like period, epoch, duration, depth.
- lightcurvelightkurve object
lightkurve object with the time and flux of the data to use for vetting.
- plot: bool
option to show plot when initialy populating the metrics. Same as using the plot() method.
- Returns:
- metricsdict
'msg'
contains warnings, if applicable.'amp'
contains the best fit amplitude, its uncertainty, and amplitude-to-uncertainty ratio for half-period, period, and twice the period.