matplotlib.axes.Axes.xcorr
-
Axes.xcorr(self, x, y, normed=True, detrend=<function detrend_none at 0x7f8092177c80>, usevlines=True, maxlags=10, *, data=None, **kwargs)[source] -
Построение взаимной корреляции между x и y.
Корреляция с лагом k определяется как \(\sum_n x[n+k] \cdot y^*[n]\), где \(y^*\) — комплексно сопряжённое значение \(y\).
Параметры: -
x : array-like of length n -
y : array-like of length n -
detrend : callable, optional, default: mlab.detrend_none -
x и y обеспределяются с помощью callable detrend. Эта функция должна
x = detrend(x)принимать и возвращатьnumpy.array. По умолчанию нормализация не применяется. -
normed : bool, optional, default: True -
Если
True, векторы входных данных нормализуются до единичной длины. -
usevlines : bool, optional, default: True -
Определяет стиль графика.
Если
True, рисуются вертикальные линии от 0 до значения xcorr, используяAxes.vlines. Кроме того, рисуется горизонтальная линия на уровне y=0 с помощьюAxes.axhline.Если
False, маркеры рисуются на значениях xcorr с помощьюAxes.plot. -
maxlags : int, optional, default: 10 -
Количество отображаемых лагов. Если None, будут возвращены все
2 * len(x) - 1лаги.
Возвращает: -
lags : array (length 2*maxlags+1) -
Вектор лагов.
-
c : array (length 2*maxlags+1) -
Вектор автокорреляции.
-
line : LineCollection or Line2D -
Artist, добавленные на ось корреляции:-
LineCollection, если usevlines равно True. -
Line2D, если usevlines равно False.
-
-
b : Line2D or None -
Горизонтальная линия на уровне 0, если usevlines равно True. None, если usevlines равно False.
Другие параметры: -
linestyle : Line2D property, optional -
Стиль линии для отображения точек данных. Используется только если usevlines равно
False. -
marker : str, optional, default: 'o' -
Маркер для отображения точек данных. Используется только если usevlines равно
False.
Примечания
Взаимная корреляция вычисляется с помощью
numpy.correlate()сmode = "full".Примечание
В дополнение к описанным выше аргументам, эта функция может принимать ключевой аргумент data. Если такой аргумент data задан, следующие аргументы заменяются на data[<arg>]:
- Все аргументы с именами 'x', 'y'.
Объекты, переданные как data, должны поддерживать доступ к элементам (
data[<arg>]) и проверку на вхождение (<arg> in data). -
Примеры использования matplotlib.axes.Axes.xcorr
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.axes.Axes.xcorr.html