pyrfu.pyrf.autocorr module#
- pyrfu.pyrf.autocorr.autocorr(inp, maxlags: int | None = None, normed: bool = True)[source]#
Compute the autocorrelation function
- Parameters:
inp (xarray.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:
out – Autocorrelation function
- Return type: