Skip to content
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.

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

DOC: antialiasing filter and link decimate resample, etc. #6071

Merged
merged 2 commits into from Apr 24, 2016

Conversation

endolith
Copy link
Member

No description provided.

@codecov-io
Copy link

@@            master   #6071   diff @@
======================================
  Files          238     238       
  Stmts        43865   43867     +2
  Branches      8219    8219       
  Methods          0       0       
======================================
+ Hit          34293   34298     +5
+ Partial       2604    2602     -2
+ Missed        6968    6967     -1

Review entire Coverage Diff as of 143381d

Powered by Codecov. Updated on successful CI builds.

@@ -1786,8 +1786,8 @@ def resample(x, num, t=None, axis=0, window=None):

See also
--------
decimate
resample_poly
decimate : Downsample the signal after applying an anti-aliasing filter.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a bit weird to mention the anti-aliasing filter here but not for resample where it's also implicitly done by truncation or resample_poly where it's done explicitly

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. How else would you describe decimation vs the others?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I can tell now decimate is just a special case of resampling, although it does allow for IIR antialiasing filters whereas resample and resample_poly do not. I'd just say downsample a signal or something and leave it at that

@larsoner
Copy link
Member

Otherwise LGTM

@e-q e-q added scipy.signal Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Apr 20, 2016
@endolith
Copy link
Member Author

ok I changed the wording a bit

@larsoner
Copy link
Member

Looks good, I'll merge once the CIs come back happy

@larsoner larsoner merged commit b8c7907 into scipy:master Apr 24, 2016
@larsoner
Copy link
Member

Thanks @endolith

@ev-br ev-br added this to the 0.18.0 milestone Apr 24, 2016
@endolith endolith deleted the patch-3 branch April 24, 2016 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.signal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants