Returns a FoldedLightCurve object folded on a period and epoch.
This method is identical to AstroPy’s fold()
method, except it returns a FoldedLightCurve object which offers
convenient plotting methods.
The period to use for folding. If a float is 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.
Phase of epoch_time. If normalize_phase is True, this
should be a dimensionless value, while if normalize_phase is
False, this should be a Quantity with time
units. Defaults to 0.
The value of the phase above which values are wrapped back by one
period. If normalize_phase is True, this should be a
dimensionless value, while if normalize_phase is False,
this should be a Quantity with time units.
Defaults to half the period, so that the resulting time series goes
from -period / 2 to period / 2 (if normalize_phase is
False) or -0.5 to 0.5 (if normalize_phase is True).
-period / 2
period / 2
If False phase is returned as TimeDelta,
otherwise as a dimensionless Quantity.
The folded light curve object in which the time column
holds the phase values.