Fix transition bandwidth reported in 'filter too short' error (#11406) - #14005
Merged
larsoner merged 5 commits intoJul 8, 2026
Merged
Conversation
CedricConday
requested review from
agramfort,
drammock and
larsoner
as code owners
June 30, 2026 03:46
larsoner
reviewed
Jun 30, 2026
Comment on lines
+1141
to
+1142
| import mne | ||
|
|
…-tools#11406) The error reported transition * sfreq / 2.0, but transition is already half the Nyquist-normalized width, so it displayed half the actual transition band (e.g. 0.50 Hz for a requested 1.0 Hz). Report transition * sfreq. Adds a regression test.
for more information, see https://pre-commit.ci
CedricConday
force-pushed
the
fix/notch-filter-error-message
branch
from
July 3, 2026 11:43
eb8dfb2 to
f156838
Compare
nordme
reviewed
Jul 8, 2026
nordme
left a comment
Contributor
There was a problem hiding this comment.
Hi @CedricConday , thanks for the PR!
Generally looks good to me except I suggest passing a raw fixture into the test function.
| def test_filter_too_short_error_reports_correct_transition(): | ||
| """The 'too short' filter error must report the true transition band (gh-11406).""" | ||
| sfreq = 1000.0 | ||
| raw = mne.io.RawArray( |
Contributor
There was a problem hiding this comment.
We've got a raw fixture in conftest.py so you don't have to do any array creation!
Contributor
Author
Member
|
Thanks @CedricConday ! |
larsoner
added a commit
to larsoner/mne-python
that referenced
this pull request
Jul 8, 2026
* upstream/main: Fix transition bandwidth reported in 'filter too short' error (mne-tools#11406) (mne-tools#14005)
larsoner
added a commit
to sharifhsn/mne-python
that referenced
this pull request
Jul 14, 2026
* upstream/main: (206 commits) Improve type checks (mne-tools#14036) Make scrollbar handlers draggable (mne-tools#14040) [pre-commit.ci] pre-commit autoupdate (mne-tools#14052) Warn when Epochs events fall outside the raw data range (mne-tools#12989) (mne-tools#14004) Ensure epochs being concatenated have compatible event ids (mne-tools#14051) Widen main content area (mne-tools#14015) MAINT: remove dead gain/bits/value_range fields from _read_header in … (mne-tools#14047) ENH: replace `_get_blocks` binary reader with mffpy Reader API (mne-tools#14043) MAINT: Update dependency specifiers (mne-tools#14048) [dependabot]: Bump the actions group with 2 updates (mne-tools#14049) Simplify doc building with more refleak (mne-tools#14045) ENH: add overlay Brain GUI (mne-tools#14031) ENH: support multiple simultaneous overlays in Brain.add_data (mne-tools#13995) Add option to show a zero line in browser (mne-tools#14018) FIX: pass cmap name string not tuple to interactive topomap slider kwargs (mne-tools#14039) Doc/add ai policy pointer (mne-tools#14037) Allow subclasses of FigureClass to be passed to plot_raw/plot_epochs (mne-tools#13979) MAINT: Replace manual PNS binary block reader in `_read_segment_file` with `mffpy` (mne-tools#14030) Fix transition bandwidth reported in 'filter too short' error (mne-tools#11406) (mne-tools#14005) ENH: Show the current time as a vertical line in plot_evoked_topo (mne-tools#14032) ...
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
3 participants
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.
Fixes #11406
What was wrong
When a requested FIR
filter_lengthis too short, the raised error reports the transition bandwidth astransition * sfreq / 2.0. Buttransitionis computed as(prev_freq - this_freq) / 2.0where the frequencies are already normalized to the Nyquist rate, so it is already half the Nyquist-normalized width. Multiplying bysfreq / 2.0therefore displays half the real transition band — e.g. a requestedl_trans_bandwidth=1.0Hz is reported as0.50 Hz.this_N(the required length) is computed correctly; only the message is wrong.Fix
Report
transition * sfreq, which is the true transition bandwidth.Test
Adds
test_filter_too_short_error_reports_correct_transition: a too-short filter withl_trans_bandwidth=1.0now reports1.00 Hz transition band. Verified it reports0.50 Hzonmainand1.00 Hzwith this change.AI-assisted, human-reviewed — I'm an AI engineer; I find, fix, and test with AI (Claude Code), then review and verify before opening.