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] - Split up & extend filter tutorial(s) #229

Closed
TomDonoghue opened this issue Dec 30, 2020 · 1 comment
Closed

[DOC] - Split up & extend filter tutorial(s) #229

TomDonoghue opened this issue Dec 30, 2020 · 1 comment
Assignees
Labels
2.2 Updates to go into a 2.2.0 release documentation Tasks related to documentation materials & code docs.

Comments

@TomDonoghue
Copy link
Member

TomDonoghue commented Dec 30, 2020

I think it would be a good idea to re-organize and expand our Filter tutorial, which is currently one tutorial page.

A potential reorganization would split up into: FIR, IIR, and maybe an additional tutorial on the utils / plots available to explore filters.

There are some good resources on guiding the use of filters, that include demos / ideas that we could add in code:

The above linked papers have a bunch of specific and practical recommendations. With links to these papers as source, I think we could flesh out our discussion of filters to recommend these points, and demonstrate some of the issues they discuss.

Somewhat related is the idea of a Filter report (#139). Even if this isn't an explicit / separate thing, the tutorials should cover all information that should be reported by a filter, including: filter type, frequency parameters (cutoff frequency), filter order (or length), roll-off or transition bandwidth, passband ripple & stopband attenuation, filter delay (zero-phase, linear phase, etc), causality, and whether it was applied in one or two directions.

Widmann et al compare some software implementations, and also have suggestions for the user (things we should make sure are easy to do). One in particular: examine filter responses by applying them to impulses (compute the impulse response). This is something we can emphasize in the tutorials, consistently showing and doing this.

@TomDonoghue TomDonoghue added documentation Tasks related to documentation materials & code docs. 2.2 Updates to go into a 2.2.0 release labels Apr 10, 2021
@TomDonoghue
Copy link
Member Author

This topic is covered in #232, which is being finished to merge, so this issue can be closed now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.2 Updates to go into a 2.2.0 release documentation Tasks related to documentation materials & code docs.
Projects
None yet
Development

No branches or pull requests

2 participants