Spec-Zone.ru › Matplotlib 3.7

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.

dataиндексируемый объект, необязательно

Если задан, следующие параметры также принимают строку s, которая интерпретируется как data[s] (если это не вызывает исключения):

x, y

**kwargs

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

Примечания

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

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

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

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

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

Spec-Zone.ru

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