Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 258dbf5

Browse filesBrowse files
authored
Merge pull request matplotlib#7470 from dstansby/correlation-docstrings
DOC: Clarify cross correlation documentation matplotlib#1835
2 parents f550f8b + 52c8d18 commit 258dbf5
Copy full SHA for 258dbf5

File tree

Expand file treeCollapse file tree

1 file changed

+4
-4
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+4
-4
lines changed

‎lib/matplotlib/axes/_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_axes.py
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1673,8 +1673,7 @@ def acorr(self, x, **kwargs):
16731673
normalization.
16741674
16751675
normed : boolean, optional, default: True
1676-
if True, normalize the data by the autocorrelation at the 0-th
1677-
lag.
1676+
if True, input vectors are normalised to unit length.
16781677
16791678
usevlines : boolean, optional, default: True
16801679
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,
17231722
"""
17241723
Plot the cross correlation between *x* and *y*.
17251724
1725+
The correlation with lag k is defined as sum_n x[n+k] * conj(y[n]).
1726+
17261727
Parameters
17271728
----------
17281729
@@ -1737,8 +1738,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
17371738
normalization.
17381739
17391740
normed : boolean, optional, default: True
1740-
if True, normalize the data by the autocorrelation at the 0-th
1741-
lag.
1741+
if True, input vectors are normalised to unit length.
17421742
17431743
usevlines : boolean, optional, default: True
17441744
if True, Axes.vlines is used to plot the vertical lines from the

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.