8000 Clarify cross correlation documentation #1835 by dstansby · Pull Request #7470 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Clarify cross correlation documentation #1835 #7470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 20, 2016
Merged

Clarify cross correlation documentation #1835 #7470

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
----------

Expand All @@ -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
Expand Down
0