pyActigraphy.analysis.LIDS.lids_period

LIDS.lids_period(freq='s')

LIDS period

Convert the period of the LIDS oscillations as estimated by the fit function to a TimeDelta.

Parameters

s (str, optional) – Frequency to cast the output timedelta to. Default is ‘s’.

Returns

lids_period

Return type

numpy.timedelta64[freq]

Note

As there is no way to automatically derive the LIDS period from the fit parameters, the fitted period needs to be set via its own setter function.