matplotlib.pyplot.xcorr

matplotlib.pyplot.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".