From 52c8d1899b7df0e7fa06e7a63cfe3550b41e6efe Mon Sep 17 00:00:00 2001 From: David Stansby Date: Wed, 16 Nov 2016 21:13:02 +0000 Subject: [PATCH] Clarify cross correlation documentation --- lib/matplotlib/axes/_axes.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index c4f05f85df94..a8f58d2de2da 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -1673,8 +1673,7 @@ def acorr(self, x, **kwargs): normalization. normed : boolean, optional, default: True - if True, normalize the data by the autocorrelation at the 0-th - lag. + if True, input vectors are normalised to unit length. usevlines : boolean, optional, default: True if True, Axes.vlines is used to plot the vertical lines from the @@ -1723,6 +1722,8 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none, """ Plot the cross correlation between *x* and *y*. + The correlation with lag k is defined as sum_n x[n+k] * conj(y[n]). + Parameters ---------- @@ -1737,8 +1738,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none, normalization. normed : boolean, optional, default: True - if True, normalize the data by the autocorrelation at the 0-th - lag. + if True, input vectors are normalised to unit length. usevlines : boolean, optional, default: True if True, Axes.vlines is used to plot the vertical lines from the