lightkurve.correctors.SFFCorrector#

class lightkurve.correctors.SFFCorrector(lc)[source]#

Special case of RegressionCorrector where the DesignMatrix includes the target’s centroid positions.

The design matrix also contains columns representing a spline in time design to capture the intrinsic, long-term variability of the target.

Parameters
lcLightCurve

The light curve that needs to be corrected.

__init__(lc)[source]#

Constructor method.

The constructor shall:

  • accept all data required to run the correction (e.g. light curves, target pixel files, engineering data).

  • instantiate the original_lc property.

Methods

__init__(lc)

Constructor method.

compute_overfit_metric(**kwargs)

Measures the degree of over-fitting in the correction.

compute_underfit_metric(**kwargs)

Measures the degree of under-fitting the correction.

correct([centroid_col, centroid_row, ...])

Find the best fit correction for the light curve.

diagnose()

Returns a diagnostic plot which visualizes what happened during the most recent call to correct().

diagnose_arclength()

Returns a diagnostic plot which visualizes arclength vs flux from most recent call to correct().

diagnose_priors()

Returns a diagnostic plot visualizing how the best-fit coefficients compare against the priors.

Attributes

cadence_mask

corrected_lc

dmc

Shorthand for self.design_matrix_collection.

original_lc