frites.utils.acf#

frites.utils.acf(x, axis=- 1, demean=True)[source]#

Compute the autocorrelation function.

Parameters
xnumpy:array_like

Array to use to estimate the auto-correlation. It can also be an instance of xarray.DataArray.

axispython:int, python:str | -1

Location of the temporal dimension. If the x input is a DataArray, axis can be a string (e.g axis=’times’)

demeanbool | python:True

Specify whether the mean should be removed. Default is True.

Returns
acfnumpy:array_like

Array of auto-correlation with the same shape and type as the input x