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

consolidate filter methods #44

Merged
merged 2 commits into from
Oct 20, 2023
Merged

consolidate filter methods #44

merged 2 commits into from
Oct 20, 2023

Conversation

atspaeth
Copy link
Member

Relating to the discussion with @surygeng in #41, also attn: @ashsrobbins.

  • Deprecate filter() for butter_filter()
  • Simplify filtering SpikeData.from_thresholding()

The first commit here is just deprecating the more complicated filter method whose fancy features it doesn't look like are being used.

The second is breaking, so let's reject this if people are actually using this feature: the interface of the SpikeData.from_thresholding() constructor was overly complicated, with 4 different kwargs being used for the optional pre-filtering. This is now simplified by just having one parameter filter that gives the parameters for butter_filter(), and can be None to emulate the previous do_filter=False behavior.

Copy link
Member

@DailyDreaming DailyDreaming left a comment

Choose a reason for hiding this comment

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

This looks good to me. If inclined, I'd add a test, but otherwise I think this is good to merge.

@atspaeth atspaeth merged commit 46bd43c into master Oct 20, 2023
1 check failed
@atspaeth atspaeth deleted the consolidate-filter-methods branch October 20, 2023 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants