matplotlib.pyplot.acorr#
- matplotlib.pyplot.acorr(x, *, data=None, **kwargs)[source]#
Plot the autocorrelation of x.
- Parameters
- xarray-like
- 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 usingAxes.vlines
. Additionally, a horizontal line is plotted at y=0 usingAxes.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.
- line
LineCollection
orLine2D
Artist
added to the Axes of the correlation:LineCollection
if usevlines is True.Line2D
if usevlines is False.
- b
Line2D
or None Horizontal line at 0 if usevlines is True None usevlines is False.
- lagsarray (length
- Other Parameters
- linestyle
Line2D
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 asdata[s]
(unless this raises an exception):x
- **kwargs
Additional parameters are passed to
Axes.vlines
andAxes.axhline
if usevlines isTrue
; otherwise they are passed toAxes.plot
.
- linestyle
Notes
The cross correlation is performed with
numpy.correlate
withmode = "full"
.