Documentation for TESSCutCorrector
Remove TESS jitter and sky background noise using linear regression.
Will automatically generate a design matrix based on tess_backdrop stored files.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tpf |
`lightkurve.TargetPixelFile` |
The target pixel file for a target |
required |
aperture_mask |
np.ndarray of booleans |
Aperture mask to apply to TPF. If none, one will be
selected per |
's.' |
correct(self, cadence_mask=None, sigma=5, niters=3, propagate_errors=False, spline_timescale=0.5, spline_degree=3, npca_components=10)
Returns a systematics-corrected light curve from a TESSCut TPF.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cadence_mask |
np.ndarray of bools |
Mask, where True indicates a cadence that should be used. |
None |
sigma |
int (default 5) |
Standard deviation at which to remove outliers from fitting |
5 |
niters |
int (default 5) |
Number of iterations to fit and remove outliers |
3 |
propagate_errors |
bool (default False) |
Whether to propagate the uncertainties from the regression. Default is False. Setting to True will increase run time, but will sample from multivariate normal distribution of weights. |
False |
spline_timescale |
float, None |
Time between knots in spline component. If None, will not use spline. |
0.5 |
spline_degree |
int |
Polynomial degree of spline. |
3 |
npca_components |
int, default 10 |
Number of terms added to the design matrix for jitter correction. |
10 |
Returns:
| Type | Description |
|---|---|
`lightkurve.LightCurve` |
Systematics-corrected |