Skip to content

Commit

Permalink
Merge pull request #5538 from aolsux/patch-1
Browse files Browse the repository at this point in the history
DOC: signal: fix find_peaks_cwt documentation
  • Loading branch information
rgommers committed Nov 25, 2015
2 parents 823bac3 + 86c4c99 commit 7f208fa
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions scipy/signal/_peak_finding.py
Original file line number Diff line number Diff line change
Expand Up @@ -435,8 +435,10 @@ def find_peaks_cwt(vector, widths, wavelet=None, max_distances=None,
1-D array of widths to use for calculating the CWT matrix. In general,
this range should cover the expected width of peaks of interest.
wavelet : callable, optional
Should take a single variable and return a 1-D array to convolve
with `vector`. Should be normalized to unit area.
Should take two parameters and return a 1-D array to convolve
with `vector`. The first parameter determines the number of points
of the returned wavelet array, the second parameter is the scale
(`width`) of the wavelet. Should be normalized and symmetric.
Default is the ricker wavelet.
max_distances : ndarray, optional
At each row, a ridge line is only connected if the relative max at
Expand Down

0 comments on commit 7f208fa

Please sign in to comment.