matplotlib.pyplot.acorr — Matplotlib 3.10.3 documentation (original) (raw)
matplotlib.pyplot.acorr(x, *, data=None, **kwargs)[source]#
Plot the autocorrelation of x.
Parameters:
xarray-like
Not run through Matplotlib's unit conversion, so this should be a unit-less array.
detrendcallable, default: mlab.detrend_none (no detrending)
A detrending function applied to x. It must have the signature
detrend(x: np.ndarray) -> np.ndarray
normedbool, default: True
If True, input vectors are normalised to unit length.
usevlinesbool, default: True
Determines the plot style.
If True, vertical lines are plotted from 0 to the acorr value using Axes.vlines. Additionally, a horizontal line is plotted at y=0 using Axes.axhline.
If False, markers are plotted at the acorr values usingAxes.plot.
maxlagsint, default: 10
Number of lags to show. If None, will return all2 * len(x) - 1 lags.
Returns:
lagsarray (length 2*maxlags+1)
The lag vector.
carray (length 2*maxlags+1)
The auto correlation vector.
lineLineCollection or Line2D
Artist added to the Axes of the correlation:
- LineCollection if usevlines is True.
- Line2D if usevlines is False.
bLine2D or None
Horizontal line at 0 if usevlines is True None usevlines is False.
Other Parameters:
linestyleLine2D property, optional
The linestyle for plotting the data points. Only used if usevlines is False.
markerstr, default: 'o'
The marker for plotting the data points. Only used if usevlines is False.
dataindexable object, optional
If given, the following parameters also accept a string s, which is interpreted as data[s] if s is a key in data:
x
**kwargs
Additional parameters are passed to Axes.vlines andAxes.axhline if usevlines is True; otherwise they are passed to Axes.plot.
Notes
The cross correlation is performed with numpy.correlate withmode = "full".