doc: clarify ica.apply include and exclude params #10086
Merged
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.
That's how I understand it (and the code looks like it in the source and when running it) ... so I thought I'd add this to the docstring to clear things up.
The relevant things happen here:
mne-python/mne/preprocessing/ica.py
Lines 1796 to 1801 in c3ff05c
where
_check_excludedoes this (either union ofica.excludeandexclude, or justica.exclude, ifexcludeis "n/a"):mne-python/mne/preprocessing/ica.py
Lines 1726 to 1731 in c3ff05c
includeis handled a few lines below in_pick_sources:mne-python/mne/preprocessing/ica.py
Lines 1820 to 1824 in c3ff05c
i.e., all are
includedifNone... else the specific selection specified ... and then idxs are removed from it usingexcludeas previously triaged