ENH: Make number of ICA components plotted in reports dynamic#13958
Open
athishdresu wants to merge 4 commits into
Open
ENH: Make number of ICA components plotted in reports dynamic#13958athishdresu wants to merge 4 commits into
athishdresu wants to merge 4 commits into
Conversation
athishdresu
requested review from
agramfort,
drammock and
larsoner
as code owners
athishdresu
force-pushed
the
ica-report-fix
branch
from
352cd1f to
35cce40
Compare
for more information, see https://pre-commit.ci
…ython into ica-report-fix
athishdresu
force-pushed
the
ica-report-fix
branch
from
e0c668b to
89a9ba6
Compare
Author
|
I have updated the docstrings in mne/viz/ica.py, mne/preprocessing/ica.py, and mne/report/report.py to include the new n_channels parameter and resolve the Sphinx build warnings. Let me know if anything else is needed |
larsoner
reviewed
Jun 15, 2026
| inst : instance of Raw, Epochs or Evoked | ||
| The object to plot the sources from. | ||
| %(picks_ica)s | ||
| : int | None |
Comment on lines
+83
to
+84
| n_channels : int | None | ||
| The number of ICA components to plot. If None, defaults to 20. |
Member
There was a problem hiding this comment.
I think n_components might be a better name... they are stored as channels in the object but users will think in terms of components. Also needs versionadded.
Suggested change
| n_channels : int | None | |
| The number of ICA components to plot. If None, defaults to 20. | |
| n_components : int | |
| Maximum number of ICA components to plot. Defaults to 20. | |
| .. versionadded:: 1.13 |
| picks=None, | ||
| start=None, | ||
| stop=None, | ||
| n_channels=None, |
Member
There was a problem hiding this comment.
Suggested change
| n_channels=None, | |
| n_components=20, |
| exclude, | ||
| start=start, | ||
| stop=stop, | ||
| n_channels=n_channels, |
Member
There was a problem hiding this comment.
And I'd update this everywhere
Suggested change
| n_channels=n_channels, | |
| n_components=n_components, |
| %(picks_ica)s This only affects the behavior of the component | ||
| topography and properties plots. | ||
| n_channels : int | None | ||
| The number of ICA components to plot. If None, defaults to 20. |
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.
This PR addresses issue #13889 by removing the hard-coded limit of 20 components in
_plot_sourcesand allowing the user to dynamically specify the number of ICA components to plot via a newn_channelsparameter.Changes made:
n_channelsparameter toplot_ica_sources,_plot_sources, and theadd_icareport generation methods.report.pyto propagate this parameter through the report generation pipeline._plot_sourcesto default to 20 ifn_channelsis not specified, ensuring backward compatibility.Fixes #13889