pyActigraphy.filters.FiltersMixin.add_mask_period

FiltersMixin.add_mask_period(start, stop, error='raise')[source]

Add a period to the inactivity mask

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

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

  • error (str) – If set to ‘raise’, raise a ValueError whenever the mask period is not within the recording’s start/stop times. If set to ‘warn’, simply issue a warning. Available options are: [‘raise’,’warn’]. Default is ‘raise’.