pyhctsa.operations.correlation.autocorr_shape

pyhctsa.operations.correlation.autocorr_shape(y, stop_when='posDrown')

How the autocorrelation function changes with the time lag.

Outputs include the number of peaks, and autocorrelation in the autocorrelation function (ACF) itself.

Parameters:
y : array-like

The input time series

stop_when : str or int, optional

The criterion for the maximum lag to measure the ACF up to. Default is ‘posDrown’.

Returns:

A dictionary containing various metrics about the autocorrelation function.

Return type:

dict