VizTransits
- class exovetter.vetters.VizTransits(lc_name='flux', max_transits=10, transit_only=False, smooth=10, transit_plot=False, folded_plot=False)[source]
Bases:
BaseVetterClass to return the number of transits that exist. It primarily plots all the transits on one figure along with a folded transit.
- Parameters:
- lc_namestr
Name of the flux array in the
lightkurveobject.- max_transitsbool
Total number of transits to plot.
- transit_onlybool
Zoom in on the transit
- smoothtype
description
- transit_plotbool
Whether or not to show the transit plot
- folded_plotbool
Wheter or not to show the folded plot
- Attributes:
- tcetce object
tce object is a dictionary that contains information about the tce to vet, like period, epoch, duration, depth.
- metricsdict
VizTransits result dictionary populated by
run().
Methods Summary
plot()Generate a diagnostic plot.
run(tce, lightcurve[, plot])Runs viz_transits.plot_all_transits to populate the vetter object.
Methods Documentation
- run(tce, lightcurve, plot=False)[source]
Runs viz_transits.plot_all_transits 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 folded and unfolded plot. If true both will show.
- Returns:
- metricsdict
- centroid result dictionary containing the following:
num_transits : Number of transits with data in transit (3*duration).