pyActigraphy.metrics.MetricsMixin.average_daily_light¶
- MetricsMixin.average_daily_light(freq='5min', cyclic=False)[source]¶
Average daily light distribution
Calculate the daily profile of light exposure (in lux). Data are averaged over all the days.
- Parameters
freq (str, optional) – Data resampling frequency. Cf. #timeseries-offset-aliases in <https://pandas.pydata.org/pandas-docs/stable/timeseries.html>.
cyclic (bool, optional) – If set to True, two daily profiles are concatenated to ensure continuity between the last point of the day and the first one. Default is False.
- Returns
raw – A Series containing the daily profile of light exposure with a 24h index.
- Return type
pandas.Series