Centroid

class exovetter.vetters.Centroid(lc_name='flux', diff_plots=False, centroid_plots=False)

Bases: BaseVetter

Class to handle centroid vetting

Parameters:

lc_namestr

Name of the flux array in the lightkurve object.

diff_plotsbool

Show centroid difference plots

centroid_plotsbool

Show centroid summary plot

Attributes:

tcetce object

tce object is a dictionary that contains information about the tce to vet, like period, epoch, duration, depth.

tpfobj

lightkurve target pixel file object with pixels in column lc_name

metricsdict

Centroid result dictionary populated by run().

Methods Summary

plot()	Generate a diagnostic plot.
run(tce, lk_tpf[, plot, remove_transits])	Runs cent.compute_diff_image_centroids and cent.measure_centroid_shift to populate the vetter object.

Methods Documentation

plot()

Generate a diagnostic plot.

Parameters:

tce, lightcurve

See run().

run(tce, lk_tpf, plot=False, remove_transits=None)

Runs cent.compute_diff_image_centroids and cent.measure_centroid_shift 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.

lk_tpf: obj

lightkurve target pixel file object with pixels in column lc_name

plotbool

option to show plot when initialy populating the metrics. Same as using the plot() method.

remove_transitslist

List of 0 indexed transit integers to not calculate on.

Returns:

metricsdict

centroid result dictionary containing the following:

offset : (float) Size of offset in pixels (or whatever unit centroids is in) significance : (float) The statistical significance of the transit. Values close to 1 mean the transit is likely on the target star. Values less than ~1e-3 suggest the target is not the source of the transit.