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