pyActigraphy.metrics.MetricsMixin.L5

MetricsMixin.L5(binarize=True, threshold=4)[source]

Mean activity during the 5 least active hours of the day.

Parameters
  • binarize (bool, optional) – If set to True, the data are binarized. Default is True.

  • threshold (int, optional) – If binarize is set to True, data above this threshold are set to 1 and to 0 otherwise. Default is 4.

Returns

l5

Return type

float

Notes

The L5 [1] variable is calculated as the mean, per acquisition period, of the average daily activities during the 5 least active hours.

Warning

The value of this variable depends on the length of the acquisition period.

References

1

Van Someren, E.J.W., Lijzenga, C., Mirmiran, M., Swaab, D.F. (1997). Long-Term Fitness Training Improves the Circadian Rest-Activity Rhythm in Healthy Elderly Males. Journal of Biological Rhythms, 12(2), 146–156. http://doi.org/10.1177/074873049701200206

Examples

>>> import pyActigraphy
>>> rawAWD = pyActigraphy.io.read_raw_awd(fpath + 'SUBJECT_01.AWD')
>>> rawAWD.L5()
0.XXXX
>>> rawAWD.L5(binarize=False)
0.XXXX