- LightCurve.fold(period=None, epoch_time=None, epoch_phase=0, wrap_phase=None, normalize_phase=False)¶
FoldedLightCurveobject folded on a period and epoch.
This method is identical to AstroPy’s
fold()method, except it returns a
FoldedLightCurveobject which offers convenient plotting methods.
The period to use for folding. If a
floatis passed we’ll assume it is in units of days.
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
- wrap_phasefloat or
The value of the phase above which values are wrapped back by one period. If
True, this should be a dimensionless value, while if
False, this should be a
Quantitywith time units. Defaults to half the period, so that the resulting time series goes from
-period / 2to
period / 2(if
False) or -0.5 to 0.5 (if
The folded light curve object in which the
timecolumn holds the phase values.