LightCurveFile

class lightkurve.lightcurvefile.LightCurveFile(path, **kwargs)

Bases: object

Generic class to represent FITS files which contain one or more light curves.

Parameters:
path : str or astropy.io.fits.HDUList object

Local path or remote url of a lightcurve FITS file. Also accepts a FITS file object already opened using AstroPy.

kwargs : dict

Keyword arguments to be passed to astropy.io.fits.open.

Attributes Summary

PDCSAP_FLUX Returns a LightCurve object for PDCSAP_FLUX
SAP_FLUX Returns a LightCurve object for SAP_FLUX
cadenceno Cadence number
dec Declination of the target.
ra Right Ascension of the target.
time Time measurements

Methods Summary

from_fits(path_or_url, **kwargs) WARNING: THIS FUNCTION IS DEPRECATED AND WILL BE REMOVED VERY SOON.
header([ext]) Header of the object at extension ext
plot([flux_types, style]) Plot all the light curves contained in this light curve file.

Attributes Documentation

PDCSAP_FLUX

Returns a LightCurve object for PDCSAP_FLUX

SAP_FLUX

Returns a LightCurve object for SAP_FLUX

cadenceno

Cadence number

dec

Declination of the target.

ra

Right Ascension of the target.

time

Time measurements

Methods Documentation

classmethod from_fits(path_or_url, **kwargs)

WARNING: THIS FUNCTION IS DEPRECATED AND WILL BE REMOVED VERY SOON.

Please use lightkurve.open() instead.

header(ext=0)

Header of the object at extension ext

plot(flux_types=None, style='lightkurve', **kwargs)

Plot all the light curves contained in this light curve file.

Parameters:
flux_types : str or list of str

List of flux types to plot. Default is to plot all available. (For Kepler the default fluxes are ‘SAP_FLUX’ and ‘PDCSAP_FLUX’.

style : str

matplotlib.pyplot.style.context, default is ‘fast’

kwargs : dict

Dictionary of keyword arguments to be passed to KeplerLightCurve.plot().


Created with ♥ by the Lightkurve developers. Join us on GitHub.