pyActigraphy.filters.FiltersMixin.add_mask_periods

FiltersMixin.add_mask_periods(input_fname, error='raise', *args, **kwargs)

Add periods to the inactivity mask

Function to read start and stop times from a Mask log file. Supports different file format (.ods, .xls(x), .csv).

Parameters:

• input_fname (str) – Path to the log file.

• 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’.

• *args – Variable length argument list passed to the subsequent reader function.

• **kwargs – Arbitrary keyword arguments passed to the subsequent reader function.