-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for dictionary-type ref_channels
in set_eeg_reference()
#12366
Draft
qian-chu
wants to merge
30
commits into
mne-tools:main
Choose a base branch
from
qian-chu:dict_ref
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+177
−2
Draft
Changes from 4 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
1bce965
init the PR draft
qian-chu f42d5fb
Merge branch 'main' into dict_ref
qian-chu 278fdf3
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] f3cff5a
Create 12366.newfeature.rst
qian-chu b7b5c0c
Update 12366.newfeature.rst
qian-chu 7ece510
Merge branch 'mne-tools:main' into dict_ref
qian-chu 8d4516d
Add custom reference based on dict
42f45b8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 95a1434
BF: use isintance to check if dict
c921d69
BF: remove extra copy of data
b0c91d2
Add custom reference
78a5c7e
change doc (add Alex)
ca6908c
Add warning if bad channels in re-referencing scheme
6ac7bed
Merge branch 'dict_ref' of https://github.com/qian-chu/mne-python int…
b1165b9
add _check_before_dict_reference and enrich set_eeg_reference_see_als…
qian-chu ed56c97
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] d27ce12
Update reference.py
qian-chu 073ca9d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 8d744ca
Update test_reference.py
qian-chu 9e9507d
Update reference.py
qian-chu 24d16a5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 2a6db40
Update test_reference.py
qian-chu 6699de0
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 8a5232a
formatting
qian-chu 73ad30d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 3474370
dict does not accept repeated keys, no need to test
qian-chu cd213ee
add test for warnings and raises
qian-chu 6c79a60
Update test_reference.py
qian-chu e36ddd2
Update docs.py
qian-chu 41893f3
Merge branch 'mne-tools:main' into dict_ref
qian-chu File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Add support for `dict` type argument ``ref_channels`` to :func:`mne._fiff.reference.set_eeg_reference`, by `Qian Chu`_. | ||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you explain what that allows users to do?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also I don't think we should document a private function here. Can you add references to the public API instead? Thank you
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry that I wasn't too familiar with the private/public API and simply copied the path to the function. Does :func:
mne.set_eeg_reference
work?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this is the right function! Regarding the changelog entry, can you maybe also include an example what you mean by "flexible re-referencing"? Users (not developers) should learn what nice new feature you added and how they can use it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Users will rarely call this function directly though, I suppose. They will usually call the methods of Raw, Epochs, ..., objects, so I believe these should be referenced or briefly mentioned