kepfold: phase-fold light curve data on linear ephemeris

pyke.kepfold.kepfold(infile, outfile=None, period=None, bjd0=None, bindata=False, nbins=1000, datacol='SAP_FLUX', noninteractive=False, overwrite=False, verbose=False, logfile='kepfold.log')[source]

kepfold: Phase-fold light curve data on linear ephemeris.

kepfold calculates the phase of all time-tagged data points relative to a user-supplied linear ephemeris. The relation is:

\(TIME\) is the column within the FITS light curve file containing barycenter-corrected time stamps. \(bjd0\) is a user-supplied BJD for zero phase. period is a user-supplied period in units of days. PHASE is the calculated phase for each time stamp; these results are written to a new float column in the LIGHT CURVE extension of the input file before being exported as a new file with name defined by the user. Optionally, kepfold will plot the data folded on the ephemeris and store it within a new FITS extension of the output file called FOLDED.

Parameters:

inile : str

The name of a MAST standard format FITS file containing a Kepler light curve within the first data extension.

outfile : str

The name of the output FITS file with a new extension containing a phased light curve.

period : str

Period over which to fold the light curve, in units of days.

bjd0 : float

Time of zero phase for the folded data, in units of BJD.

bindata: bool

Collect the data into discrete bins during the fold?

nbins : int

The number of phase bins to calculate.

datacol : str

The name of the FITS table column in extension 1 of infile upon which the Fourier transform will be calculated.

non-interactive : bool

If True, prevents the matplotlib window to pop up.

overwrite : bool

Overwrite the output file?

verbose : bool

Print informative messages and warnings to the shell and logfile?

logfile : str

Name of the logfile containing error and warning messages.

Examples

$ kepfold kplr010544976-2009201121230_slc.fits
  0.350471 2455002.825 --bindata --verbose
../_images/kepfold.png