pyActigraphy.light.LightMetricsMixin.TAT

LightMetricsMixin.TAT(threshold=None, start_time=None, stop_time=None, oformat=None)[source]

Time above light threshold.

Calculate the total light exposure time above the threshold.

Parameters

  • threshold (float, optional) – If not set to None, discard data below threshold before computing exposure levels. Default is None.

  • start_time (str, optional) – If not set to None, discard data before start time, on a daily basis. Supported time string: ‘HH:MM:SS’ Default is None.

  • stop_time (str, optional) – If not set to None, discard data after stop time, on a daily basis. Supported time string: ‘HH:MM:SS’ Default is None.

  • oformat (str, optional) – Output format. Available formats: ‘minute’ or ‘timedelta’. If set to ‘minute’, the result is in number of minutes. If set to ‘timedelta’, the result is a pd.Timedelta. If set to None, the result is in number of epochs. Default is None.

Returns

tat – A pandas Series with aggreagted light exposure levels per channel

Return type

pd.Series