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) -
Вектор автокорреляции.
-
line
LineCollectionилиLine2D -
Artist, добавленный в Axes корреляции:-
LineCollectionесли usevlines равно True. -
Line2Dесли usevlines равно False.
-
-
b
Line2Dили None -
Горизонтальная линия в 0, если usevlines равно True; None, если usevlines равно False.
-
lagsмассив (длина
- Дополнительные параметры:
-
-
linestyle
Line2Dсвойство, необязательно -
Стиль линии для отображения точек данных. Используется только если usevlines равно
False. - markerстрока, по умолчанию: 'o'
-
Маркер для отображения точек данных. Используется только если usevlines равно
False. - dataиндексируемый объект, необязательно
-
Если задано, следующие параметры также принимают строку
s, которая интерпретируется какdata[s](если это не вызывает исключения):x, y
- **kwargs
-
Дополнительные параметры передаются в
Axes.vlinesиAxes.axhlineесли usevlines равноTrue; в противном случае они передаются вAxes.plot.
-
linestyle
Примечания
Взаимная корреляция выполняется с помощью
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.8.4/api/_as_gen/matplotlib.axes.Axes.xcorr.html