pyActigraphy.metrics.MetricsMixin.ADAT

MetricsMixin.ADAT(binarize=True, threshold=4, rescale=True, exclude_ends=False)[source]

Total average daily activity

Calculate the total activity counts, averaged over all the days.

Parameters:

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

Returns:

adat

Return type:

int