Spec-Zone.ru › Matplotlib 3.1

matplotlib.pyplot.xcorr

matplotlib.pyplot.xcorr(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 обрабатываются с помощью функции 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.pyplot.xcorr

../../_images/sphx_glr_xcorr_acorr_demo_thumb.png

Демонстрация взаимной и автокорреляции

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.pyplot.xcorr.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API