pyActigraphy.metrics.MetricsMixin.ADATp

MetricsMixin.ADATp(period='7D', binarize=True, threshold=4, rescale=True, exclude_ends=False, verbose=False)[source]

Total average daily activity per period

Calculate the total activity counts, averaged over each consecutive period contained in the data. The number of periods

Parameters

  • period (str, optional) – Time length of the period to be considered. Must be understandable by pandas.Timedelta

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

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

  • rescale (bool, optional) – If set to True, the activity counts are rescaled to account for masked periods (if any). Default is True.

  • exclude_ends (bool, optional) – If set to True, the first and last daily periods are excluded from the calculation. Useful when the recording does start or end at midnigth. Default is False.

  • verbose (bool, optional) – If set to True, display the number of periods found in the data. Also display the time not accounted for. Default is False.

Returns

adatp

Return type

list of int