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. **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.pyplot.xcorr