lightkurve.LightCurve.fold#
- LightCurve.fold(period=None, epoch_time=None, epoch_phase=0, wrap_phase=None, normalize_phase=False)[source]#
Returns a
FoldedLightCurve
object folded on a period and epoch.This method is identical to AstroPy’s
fold()
method, except it returns aFoldedLightCurve
object which offers convenient plotting methods.- Parameters
- periodfloat
Quantity
The period to use for folding. If a
float
is passed we’ll assume it is in units of days.- epoch_time
Time
The time to use as the reference epoch, at which the relative time offset / phase will be
epoch_phase
. Defaults to the first time in the time series.- epoch_phasefloat or
Quantity
Phase of
epoch_time
. Ifnormalize_phase
isTrue
, this should be a dimensionless value, while ifnormalize_phase
isFalse
, this should be aQuantity
with time units. Defaults to 0.- wrap_phasefloat or
Quantity
The value of the phase above which values are wrapped back by one period. If
normalize_phase
isTrue
, this should be a dimensionless value, while ifnormalize_phase
isFalse
, this should be aQuantity
with time units. Defaults to half the period, so that the resulting time series goes from-period / 2
toperiod / 2
(ifnormalize_phase
isFalse
) or -0.5 to 0.5 (ifnormalize_phase
isTrue
).- normalize_phasebool
If
False
phase is returned asTimeDelta
, otherwise as a dimensionlessQuantity
.
- periodfloat
- Returns
- folded_lightcurve
FoldedLightCurve
The folded light curve object in which the
time
column holds the phase values.
- folded_lightcurve