Spec-Zone.ru › Matplotlib 3.4

matplotlib.axes.Axes.xcorr

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

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

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

Параметры:
x, yмассив-подобный объект длиной n
detrendфункция, по умолчанию: mlab.detrend_none (без сглаживания)

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

detrend(x: np.ndarray) -> np.ndarray
normedbool, по умолчанию: True

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

usevlinesbool, по умолчанию: True

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

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

Если False, точки xcorr выводятся с помощью Axes.plot.

maxlagsint, по умолчанию: 10

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

Возвращает:
lagsмассив (длиной 2*maxlags+1)

Вектор лагов.

cмассив (длиной 2*maxlags+1)

Вектор автокорреляции.

lineLineCollection или Line2D

Artist, добавленный в ось корреляции:

  • LineCollection, если usevlines равно True.
  • Line2D, если usevlines равно False.
bLine2D или None

Горизонтальная линия в 0, если usevlines равно True, None, если usevlines равно False.

Другие параметры:
linestyleLine2D свойство, необязательно

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

markerстрока, по умолчанию: '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–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/matplotlib.axes.Axes.xcorr.html

Spec-Zone.ru

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