matplotlib.axes.Axes.xcorr#
- Axes.xcorr(x, y, *, normed=True, detrend=<function detrend_none>, usevlines=True, maxlags=10, data=None, **kwargs)[Quelle]#
Plottet die Kreuzkorrelation zwischen x und y.
Die Korrelation mit Lag k ist definiert als \(\sum_n x[n+k] \cdot y^*[n]\), wobei \(y^*\) die komplexe Konjugierte von \(y\) ist.
- Parameter:
- x, yArray-ähnlich der Länge n
Weder x noch y werden durch Matplotlibs Einheitenkonvertierung geleitet, daher sollten dies Einheitenlose Arrays sein.
- detrendcallable, Standard:
mlab.detrend_none(kein Detrending) Eine Detrending-Funktion, die auf x und y angewendet wird. Sie muss die Signatur haben
detrend(x: np.ndarray) -> np.ndarray
- normedbool, Standard: True
Wenn
True, werden Eingabevektoren auf Einheitslänge normiert.- usevlinesbool, Standard: True
Bestimmt den Zeichenstil.
Wenn
True, werden vertikale Linien von 0 bis zum xcorr-Wert mitAxes.vlinesgezeichnet. Zusätzlich wird eine horizontale Linie bei y=0 mitAxes.axhlinegezeichnet.Wenn
False, werden Marker bei den xcorr-Werten mitAxes.plotgezeichnet.- maxlagsint, Standard: 10
Anzahl der anzuzeigenden Lags. Wenn None, werden alle
2 * len(x) - 1Lags zurückgegeben.
- Gibt zurück:
- lagsarray (Länge
2*maxlags+1) Der Lag-Vektor.
- carray (Länge
2*maxlags+1) Der Autokorrelations-Vektor.
- line
LineCollectionoderLine2D Artist, der den Achsen der Korrelation hinzugefügt wirdLineCollection, wenn usevlines True ist.Line2D, wenn usevlines False ist.
- b
Line2Doder None Horizontale Linie bei 0, wenn usevlines True ist, None, wenn usevlines False ist.
- lagsarray (Länge
- Andere Parameter:
- linestyle
Line2DEigenschaft, optional Der Linienstil zum Zeichnen der Datenpunkte. Nur verwendet, wenn usevlines
Falseist.- markerstr, Standard: 'o'
Der Marker zum Zeichnen der Datenpunkte. Nur verwendet, wenn usevlines
Falseist.- dataindizierbares Objekt, optional
Wenn angegeben, akzeptieren die folgenden Parameter auch einen String
s, der alsdata[s]interpretiert wird, wennsein Schlüssel indataistx, y
- **kwargs
Zusätzliche Parameter werden an
Axes.vlinesundAxes.axhlineübergeben, wenn usevlinesTrueist; andernfalls werden sie anAxes.plotübergeben.
- linestyle
Anmerkungen
Die Kreuzkorrelation wird mit
numpy.correlatemitmode = "full"durchgeführt.