Spec-Zone.ru › Matplotlib 2.2

matplotlib.pyplot.xcorr

matplotlib.pyplot.xcorr(x, y, normed=True, detrend=<function detrend_none>, usevlines=True, maxlags=10, hold=None, data=None, **kwargs) [source]

Построение взаимной корреляции между x и y.

Корреляция с задержкой k определяется как sum_n x[n+k] * conj(y[n]).

Параметры:
x : sequence of scalars of length n
y : sequence of scalars of length n
hold : bool, optional, deprecated, default: True
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 (lenth 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.

Другие параметры:
linestyle : Line2D property, optional

Используется только если usevlines равно False.

marker : string, optional

По умолчанию 'o'.

Примечания

Взаимная корреляция выполняется с помощью numpy.correlate() с mode = 2.

Примечание

В дополнение к вышеописанным аргументам, эта функция может принимать ключевой аргумент data. Если такой аргумент data задан, следующие аргументы заменяются на data[<arg>]:

  • Все аргументы со следующими именами: 'x', 'y'.

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

Spec-Zone.ru

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