MRG: Suppress MaxShield warning in many places #1000
Merged
Conversation
This file contains 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
hoechenberger
force-pushed
the
maxshield-warn
branch
from
5cf195f
to
02f8e05
Compare
hoechenberger
changed the title
When reading FIFF files that contain Neuromag data recorded with active shielding enabled, MNE-Python by default raises an exception unless `allow_maxshield` is specified. We used to set it to `True` in all applicable places. However, this would still issue a warning. Setting it to `'yes'` instead suppresses this warning. Consequently, I've changed all but one occurance of `allow_maxshield` to `'yes'` now. The only exception is in `read_raw_bids()`, where I believe it still makes sense to issue the warning. For all other places, like `write_raw_bids()`, `get_head_mri_trans()` etc., the warning is gone now.
hoechenberger
force-pushed
the
maxshield-warn
branch
from
02f8e05
to
a3348dc
Compare
agramfort
approved these changes
Apr 16, 2022
hoechenberger
changed the title
Codecov Report
@@ Coverage Diff @@
## main #1000 +/- ##
=======================================
Coverage 95.15% 95.15%
=======================================
Files 25 25
Lines 3776 3776
=======================================
Hits 3593 3593
Misses 183 183
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When reading FIFF files that contain Neuromag data recorded with active shielding enabled, MNE-Python by default raises an exception unless
allow_maxshieldis specified. We used to set it toTruein all applicable places. However, this would still issue a warning.Setting it to
'yes'instead suppresses this warning.Consequently, I've changed all but one occurance of
allow_maxshieldto'yes'now. The only exception is inread_raw_bids(), where I believe it still makes sense to issue the warning. For all other places,like
write_raw_bids(),get_head_mri_trans()etc., the warning is gone now.Merge checklist
Maintainer, please confirm the following before merging: