pyActigraphy.light.LightRecording.add_light_mask_period

LightRecording.add_light_mask_period(start, stop, channel=None)[source]

Add a masking period.

This period extends between the specified start and stop times. It is possible to target a specific channel. If None is used, the masking period is set on all channels.

Parameters

  • start (str) – Start time (YYYY-MM-DD HH:MM:SS) of the masking period.

  • stop (str) – Stop time (YYYY-MM-DD HH:MM:SS) of the masking period.

  • channel (str, optional) – Set masking period to a specific channel (i.e. column). If set to None, the period is set on all channels. Default is None.