pyActigraphy.light.LightMetricsMixin.light_exposure_level

LightMetricsMixin.light_exposure_level(threshold=None, start_time=None, stop_time=None, agg='mean')[source]

Light exposure level

Calculate the aggregated (mean, median, etc) light exposure level per epoch.

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.

  • agg (str, optional) – Aggregating function used to summarize exposure levels. Available functions: ‘mean’, ‘median’, ‘std’, etc. Default is ‘mean’.

Returns

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

Return type

pd.Series