Spec-Zone.ru › Matplotlib 3.2

matplotlib.axes.Axes.xcorr

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

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

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

Параметры:
xarray-like of length n
yarray-like of length n
detrendcallable, optional, default: mlab.detrend_none

x и y обесцениваются вызываемой функцией detrend. Эта функция должна x = detrend(x) принимать и возвращать numpy.array. По умолчанию нормализация не применяется.

normedbool, optional, default: True

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

usevlinesbool, optional, default: True

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

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

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

maxlagsint, optional, 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, optional, default: 'o'

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

Примечания

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

Примечание

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

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

Объекты, переданные в качестве data, должны поддерживать доступ по элементам (data[<arg>]) и проверку на членство (<arg> 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.2.2/api/_as_gen/matplotlib.axes.Axes.xcorr.html

Spec-Zone.ru

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