matplotlib.axes.Axes.acorr
- Axes. acorr ( x, *, data=None, **kwargs ) [source]
-
Plot the autocorrelation of x.
- Parameters
-
- x array-like
-
detrend
callable, default:
mlab.detrend_none
(no detrending) -
A detrending function applied to x. It must have the signature
detrend(x: np.ndarray) -> np.ndarray
- normed bool, default: True
-
If
True
, input vectors are normalised to unit length. - usevlines bool, 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
. - maxlags int, default: 10
-
Number of lags to show. If
None
, will return all2 * len(x) - 1
lags.
- Returns
-
-
lags
array (length
2*maxlags+1
) -
The lag vector.
-
c
array (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.
-
lags
array (length
- Other Parameters
-
-
linestyle
Line2D
property, optional -
The linestyle for plotting the data points. Only used if usevlines is
False
. - marker str, default: 'o'
-
The marker for plotting the data points. Only used if usevlines is
False
. - data indexable 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"
.
Examples using matplotlib.axes.Axes.acorr
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/_as_gen/matplotlib.axes.Axes.acorr.html