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