When reading FIFF files, "allow Maxshield" by default #788
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
In `main`, when trying to read a FIFF file that was recorded with activated Maxshield and hasn't been Maxwell-filtered yet, one needed to explicitly pass `extra_params=dict(allow_maxshield=True)` to `read_raw_bids()`. However, since we currently only support reading and writing "raw" data properly (i.e., no derivatives), this unncessarily complicates things: raw data is often not Maxwell-filtered, and Maxwell-filtering is one of the very first processing steps after loading the data. In contrast, IF the data was already Maxwell-filtered on the device, this would be clearly recognizible by its `proc` entity, which should indicate such processing. So this commit makes it such that FIFF files will be read with `allow_maxshield=True` by default, unless explicitly disabled via e.g. `extra_params=dict(allow_maxshield=False)`. It also removed the `--allow_maxshield` switch from the `raw_to_bids` command, as this seems similarly superfluous and is not in line with how `write_raw_bids()` handles things.
Codecov Report
@@ Coverage Diff @@
## main #788 +/- ##
=======================================
Coverage 94.19% 94.20%
=======================================
Files 23 23
Lines 2948 2952 +4
=======================================
+ Hits 2777 2781 +4
Misses 171 171
Continue to review full report at Codecov.
|
agramfort
approved these changes
May 1, 2021
sappelhoff
approved these changes
May 1, 2021
hoechenberger
added a commit
to hoechenberger/mne-bids-pipeline
that referenced
this pull request
May 1, 2021
It's superfluous now that mne-tools/mne-bids#788 has been merged.
1 task
agramfort
pushed a commit
to mne-tools/mne-bids-pipeline
that referenced
this pull request
May 1, 2021
* Drop allow_maxshield config option It's superfluous now that mne-tools/mne-bids#788 has been merged. * Forgot something
|
A bit late to the party, sorry. |
|
I think MNE issues a warning nevertheless. Now I'm wondering why we don't see this in our tests 🤔 |
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.
In
main, when trying to read a FIFF file that was recorded with activated Maxshield and hasn't been Maxwell-filtered yet, one needed to explicitly passextra_params=dict(allow_maxshield=True)toread_raw_bids().However, since we currently only support reading and writing "raw" data properly (i.e., no derivatives), this unncessarily complicates things: raw data is often not Maxwell-filtered, and Maxwell-filtering is one of the very first processing steps after loading the data. In contrast, IF the data was already Maxwell-filtered on the device, this would be clearly recognizable by its
procentity, which should indicate such processing, making any further complications just for the sake of "making users aware they need to Maxwell-filter" a bit pointless.So this commit makes it such that FIFF files will be read with
allow_maxshield=Trueby default, unless explicitly disabled via e.g.extra_params=dict(allow_maxshield=False).I also removed the
--allow_maxshieldswitch from theraw_to_bidscommand, as this seems similarly superfluous and is not in line with howwrite_raw_bids()handles things (auto-setsallow_maxshield=True)Merge checklist
Maintainer, please confirm the following before merging: