pyActigraphy.light.LightRecording.add_light_mask_periods

LightRecording.add_light_mask_periods(input_fname, channel=None, *args, **kwargs)[source]

Add masking periods from a file.

Function to read masking periods (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.

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

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

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