Let PinkNoise's anti-alias filter follow the stream's chunk_dim - #9
Merged
Conversation
WhiteNoiseProducer already declares chunk_dim="time" on what it emits, so the child Butterworth resolves to exactly the dimension it was pinned to. Passing axis="time" explicitly only asked ezmsg-sigproc 3.8 to warn about a setting no user of PinkNoise ever chose -- it is our internal wiring, not their configuration. No behaviour change, and no new version floor: the filter resolved this dimension before the setting was deprecated too. The rest of this package needs nothing. Every source that builds an AxisArray declares chunk_dim (noise, oscillator, dnss/lfp, dnss/spike), line_noise already resolves it, and dynamic_colored_noise preserves it through `replace`. The two remaining `axis=` sites -- CoordinateSpaces "ch" and AffineTransform "ch" -- name a channel axis, which is not going away.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Small, and not blocked — merges independently of the sigproc release. Verified against both released sigproc 2.23.0 and a checkout of sigproc
dev: 161 passed either way.The change
PinkNoiseProducerbuilt its child Butterworth withaxis="time".WhiteNoiseProduceralready declareschunk_dim="time"on what it emits, so the filter resolves to exactly the dimension it was pinned to — dropping the argument is behaviour-preserving.The reason to drop it: ezmsg-sigproc 3.8 deprecates
ButterworthFilterSettings.axis, and this call would have made everyPinkNoiseuser see aFutureWarningabout a setting they never chose. It's our internal wiring, not their configuration.No new version floor — the filter resolved this dimension before the setting was deprecated too.
Everything else here is already correct
I checked the rest of the package rather than assuming:
AxisArraydeclareschunk_dim—noise.py,oscillator.py(×2),dnss/lfp.py,dnss/spike.py.line_noise.pyalready resolvesmessage.chunk_dimwith aSTREAMING_DIMSfallback.dynamic_colored_noise.pyis a transformer and preserveschunk_dimthroughreplace.axis=sites —CoordinateSpacesSettings(axis="ch")invelocity2ecephys.pyandAffineTransformSettings(axis="ch")invelocity2lfp.py— name a channel axis. Those settings are not deprecated and stay configurable.Since this package is mostly sources, the thing that actually matters downstream is that they declare
chunk_dim— and they do.