8000 Update acorr and xcorr docs to match numpy docs by ColCarroll · Pull Request #12004 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Update acorr and xcorr docs to match numpy docs #12004

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
Sep 2, 2018
Merged

Update acorr and xcorr docs to match numpy docs #12004

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
6 changes: 3 additions & 3 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1885,7 +1885,7 @@ def acorr(self, x, **kwargs):
Notes
-----
The cross correlation is performed with :func:`numpy.correlate` with
``mode = 2``.
``mode = "full"``.
"""
return self.xcorr(x, x, **kwargs)

Expand Down Expand Up @@ -1946,7 +1946,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
Notes
-----
The cross correlation is performed with :func:`numpy.correlate` with
``mode = 2``.
``mode = "full"``.
"""
Nx = len(x)
if Nx != len(y):
Expand All @@ -1955,7 +1955,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
x = detrend(np.asarray(x))
y = detrend(np.asarray(y))

correls = np.correlate(x, y, mode=2)
correls = np.correlate(x, y, mode="full")

if normed:
correls /= np.sqrt(np.dot(x, x) * np.dot(y, y))
Expand Down
0