pyActigraphy.light.LightMetricsMixin.average_daily_profile_auc

LightMetricsMixin.average_daily_profile_auc(channel=None, start_time=None, stop_time=None, binarize=False, threshold=None, time_origin=None)[source]

AUC of the average daily light profile

Calculate the area under the curve of 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).

  • start_time (str, optional) – If not set to None, compute AUC from start time. Supported time string: ‘HH:MM:SS’ Default is None.

  • stop_time (str, optional) – If not set to None, compute AUC until stop time. Supported time string: ‘HH:MM:SS’ Default is None.

  • 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

auc – Area under the curve.

Return type

float