pyrfu.pyrf.autocorr module#

pyrfu.pyrf.autocorr.autocorr(inp: DataArray, maxlags: int | None = None, normed: bool | None = True) → DataArray[source]#

Compute the autocorrelation function.

Parameters:

  • inp (DataArray) – Input time series (scalar of vector).

  • maxlags (int, Optional) – Maximum lag in number of points. Default is None (i.e., len(inp) - 1).

  • normed (bool, Optional) – Flag to normalize the correlation.

Returns:

Autocorrelation function

Return type:

DataArray

Raises:

  • TypeError – If inp is not a xarray.DataArray

  • ValueError – If inp is not a scalar or a vector

  • ValueError – If maxlags is not None or strictly positive < len(inp)