pyActigraphy.light.LightMetricsMixin.average_daily_profile

LightMetricsMixin.average_daily_profile(channel, rsfreq='5min', cyclic=False, binarize=False, threshold=None, time_origin=None)[source]

Average daily light profile

Calculate the daily profile of light exposure. Data are averaged over all the days.

Parameters

  • channel (str,) – Channel to be used (i.e column of the input data).

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

  • binarize (bool, optional) – If set to True, the data are binarized. Default is False.

  • threshold (int, optional) – If binarize is set to True, data above this threshold are set to 1 and to 0 otherwise. Default is None.

  • time_origin (str or pd.Timedelta, optional) – If not None, origin of the time axis for the daily profile. Original time bins are translated as time delta with respect to this new origin. Default is None Supported time string: ‘HH:MM:SS’

Returns

raw – A Series containing the daily light profile with a 24h/48h index.

Return type

pandas.Series