biopsykit.sleep.sleep_wake_detection package

Module to perform sleep/wake detection based on Actigraphy or IMU data.

class biopsykit.sleep.sleep_wake_detection.SleepWakeDetection(algorithm_type=None, **kwargs)

Bases: object

General class for sleep/wake detection.

This class provides a generalized interface for sleep/wake detection independent of the used algorithm. When initializing a new instance the algorithm type can be specified.>

Parameters

• algorithm_type (str, optional) – name of sleep/wake detection algorithm to internally use for sleep/wake detection or None to use default algorithm (Cole/Kripke Algorithm, see ColeKripke for further information)

• kwargs – optional parameters to be passed to the sleep/wake detection algorithm. The possible parameters depend on the selected sleep/wake detection algorithm and are passed to the respective class.

sleep_wake_algo = None

predict(data, **kwargs)

Apply sleep/wake prediction on input data.

Parameters

• data (array_like) – input data

• **kwargs – additional arguments to be passed to the sleep/wake detection algorithm. The possible arguments depend on the individual algorithm.

Returns

dataframe with sleep/wake predictions

Return type

SleepWakeDataFrame

Subpackages

• biopsykit.sleep.sleep_wake_detection.algorithms package
  • Submodules
    • biopsykit.sleep.sleep_wake_detection.algorithms.cole_kripke module
    • biopsykit.sleep.sleep_wake_detection.algorithms.cole_kripke_old module
    • biopsykit.sleep.sleep_wake_detection.algorithms.sadeh module
    • biopsykit.sleep.sleep_wake_detection.algorithms.sazonov module
    • biopsykit.sleep.sleep_wake_detection.algorithms.scripps_clinic module
    • biopsykit.sleep.sleep_wake_detection.algorithms.webster module

Submodules

• biopsykit.sleep.sleep_wake_detection.sleep_wake_detection module
• biopsykit.sleep.sleep_wake_detection.utils module

biopsykit.sleep.sleep_processing_pipeline.sleep_processing_pipeline module biopsykit.sleep.sleep_wake_detection.algorithms package