Spec-Zone.ru › Matplotlib 2.1

matplotlib.axes.Axes.xcorr

Axes.xcorr(x, y, normed=True, detrend=<function detrend_none>, usevlines=True, maxlags=10, *, data=None, **kwargs)

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

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

Параметры:

x : последовательность скаляров длины n

y : последовательность скаляров длины n

hold : булево, необязательно, устарело, по умолчанию: True

detrend : вызываемая функция, необязательно, по умолчанию: mlab.detrend_none

x обрабатывается с помощью функции detrend. По умолчанию нормализация не выполняется.

normed : булево, необязательно, по умолчанию: True

если True, векторы входных данных нормализуются до единичной длины.

usevlines : булево, необязательно, по умолчанию: True

если True, используется Axes.vlines для построения вертикальных линий от начала координат до значений взаимной корреляции. В противном случае используется Axes.plot.

maxlags : целое число, необязательно, по умолчанию: 10

количество лагов для отображения. Если None, возвращаются все 2 * len(x) - 1 лагов.

Возвращает:

(lags, c, line, b) : где:

  • lags — вектор лагов длиной 2`maxlags+1.
  • c — вектор взаимной корреляции длиной 2`maxlags+1.
  • line — экземпляр Line2D, возвращаемый plot.
  • b — ось x (None, если используется plot).
Другие параметры:

linestyle : Line2D свойство, необязательно, по умолчанию: None

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

marker : строка, необязательно, по умолчанию: ‘o’

Примечания

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

Примечание

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

  • Все аргументы с именами: ‘x’, ‘y’.

© 2012–2017 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
http://matplotlib.org/2.1.0/api/_as_gen/matplotlib.axes.Axes.xcorr.html

Spec-Zone.ru

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