pyActigraphy.sleep.SleepBoutMixin.sleep_bouts

SleepBoutMixin.sleep_bouts(duration_min=None, duration_max=None, verbose=False, algo='Roenneberg', *args, **kwargs)[source]

Sleep bouts.

Activity periods identified as sleep.

Parameters:

  • duration_min (str,optional) – Minimal time duration for a sleep period. Default is None (no filtering).

  • duration_max (str,optional) – Maximal time duration for a sleep period. Default is None (no filtering).

  • verbose (bool,optional) – If set to True, display informations (start,end) about detected sleep bouts. Default is False.

  • algo (str, optional) – Sleep/wake scoring algorithm to use. Default is ‘Roenneberg’.

  • *args – Variable length argument list passed to the scoring algorithm.

  • **kwargs – Arbitrary keyword arguements passed to the scoring algorithm.

Returns:

sleep_bouts

Return type:

a list of pandas.Series

Examples

>>> import pyActigraphy
>>> rawAWD = pyActigraphy.io.read_raw_awd(fpath + 'SUBJECT_01.AWD')
>>> raw.sleep_bouts(duration_min='2h', algo='Roenneberg')
XXX