Spec-Zone.ru › Matplotlib 3.3

matplotlib.axes.Axes.xcorr

Axes.xcorr(self, x, y, normed=True, detrend=<function detrend_none at 0x7fba54bf6820>, usevlines=True, maxlags=10, *, data=None, **kwargs) [source]

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

Корреляция с лагом k определяется как \(\sum_n x[n+k] \cdot y^*[n]\), где \(y^*\) — комплексно сопряжённое значение \(y\).

Параметры:
x, yarray-like of length n
detrendcallable, default: mlab.detrend_none (no detrending)

Функция детеррендирования, применяемая к x и y. Она должна иметь сигнатуру

detrend(x: np.ndarray) -> np.ndarray
normedbool, default: True

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

usevlinesbool, default: True

Определяет стиль графика.

Если True, рисуются вертикальные линии от 0 до значения xcorr с помощью Axes.vlines. Кроме того, рисуется горизонтальная линия при y=0 с помощью Axes.axhline.

Если False, на графике отображаются маркеры в значениях xcorr с помощью Axes.plot.

maxlagsint, 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, если usevlines False.

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

Стиль линии для отображения точек данных. Используется только если usevlines False.

markerstr, default: 'o'

Маркер для отображения точек данных. Используется только если usevlines False.

**kwargs

Дополнительные параметры передаются в Axes.vlines и Axes.axhline, если usevlines True; в противном случае они передаются в Axes.plot.

Примечания

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

Примечание

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

Объекты, переданные как data, должны поддерживать доступ по элементам (data[s]) и проверку на принадлежность (s in data).

Примеры использования matplotlib.axes.Axes.xcorr

Cross- and Auto-Correlation Demo

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

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

Spec-Zone.ru

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