LightCurveFileCollection

class lightkurve.collections.LightCurveFileCollection(lightcurvefiles)

Bases: lightkurve.collections.Collection

Class to hold a collection of LightCurveFile objects.

Parameters
lightcurvefilesarray-like

List of KeplerLightCurveFile or TessLightCurveFile objects.

Attributes Summary

PDCSAP_FLUX

SAP_FLUX

Methods Summary

append(self, obj)

Appends a new object to the collection.

plot(self[, ax])

Plot all PDCSAP_FLUX light curves in the collection on a single axes.

stitch(self)

Combine all PDCSAP_FLUX extensions in the collection into a single lightkurve.lightcurve.LightCurve object.

Attributes Documentation

PDCSAP_FLUX
SAP_FLUX

Methods Documentation

append(self, obj)

Appends a new object to the collection.

Parameters
objobject

Typically a LightCurve or TargetPixelFile object

plot(self, ax=None, **kwargs)

Plot all PDCSAP_FLUX light curves in the collection on a single axes.

This a shorthand for LightCurveFileCollection.PDCSAP_FLUX.plot().

Parameters
axAxes

A matplotlib axes object to plot into. If no axes is provided, a new one will be created.

Returns
axAxes

The matplotlib axes object.

stitch(self)

Combine all PDCSAP_FLUX extensions in the collection into a single lightkurve.lightcurve.LightCurve object.

This is a shorthand for LightCurveFileCollection.PDCSAP_FLUX.stitch(). If you want to combine SAP_FLUX light curves instead, use LightCurveFileCollection.SAP_FLUX.stitch().