docs: clarify reserved CAR group names 'none' and 'emg' (fixes #792) - #794
Merged
Merged
Conversation
This update addresses issue #792 by documenting that 'none' and 'emg' are privileged/hardcoded CAR group names: - 'none': Channels marked with CAR group 'none' are excluded from common average reference (CAR) processing and will not be analyzed - 'emg' (or any CAR group containing 'emg'): Channels with CAR groups containing 'emg' are treated as EMG channels and processed separately for EMG analysis Changes: - docs/tutorials.md: Added 'Reserved CAR Group Names' section - docs/reference/core-pipeline.md: Added CAR groups section to blech_common_avg_reference.py documentation - blech_exp_info.py: Improved prompt message to clarify reserved names Co-authored-by: openhands <openhands@all-hands.dev>
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
2 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.
Summary
This PR addresses issue #792 by documenting that "none" and "emg" are reserved/hardcoded CAR group names.
Changes Made
docs/tutorials.md: Added "Reserved CAR Group Names" section explaining that:
none: Channels marked with CAR groupnoneare excluded from CAR processing and will not be analyzedemg(or any CAR group containing "emg"): Channels with CAR groups containing "emg" are treated as EMG channels and processed separately for EMG analysisdocs/reference/core-pipeline.md: Added CAR Groups section to
blech_common_avg_reference.pydocumentation explaining the reserved namesblech_exp_info.py: Improved the prompt message to clarify that "emg" and "none" are reserved names
Why This Matters
When loading channels and performing common average reference (CAR), the pipeline treats certain CAR group names specially:
noneare excluded from processingThis was not clearly documented, which could lead to user confusion when their data is processed unexpectedly.
Testing
Fixes #792