Skip to content

MRG: Improve ICA.plot_overlay() docstrings #9820

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.

Sign up for GitHub

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

Merged
hoechenberger merged 1 commit into from
Oct 8, 2021
Merged

MRG: Improve ICA.plot_overlay() docstrings #9820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion mne/utils/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,8 @@
"""
docdict["title_None"] = """
title : str | None
Title. If None (default), no title is displayed.
The title of the generated figure. If ``None`` (default), no title is
displayed.
"""
docdict["plot_proj"] = """
proj : bool | 'interactive' | 'reconstruct'
Expand Down
29 changes: 14 additions & 15 deletions mne/viz/ica.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,24 +764,23 @@ def plot_ica_overlay(ica, inst, exclude=None, picks=None, start=None,
ica : instance of mne.preprocessing.ICA
The ICA object.
inst : instance of mne.io.Raw or mne.Evoked
The signals to be compared given the ICA solution. If Raw input,
The raw data are displayed before and after cleaning. In a second
panel the cross channel average will be displayed. Since dipolar
sources will be canceled out this display is sensitive to
artifacts. If evoked input, butterfly plots for clean and raw
signals will be superimposed.
The signal to plot. If `~mne.io.Raw`, the raw data is displayed before
and after cleaning. In a second panel, the cross-channel average will
be displayed. Since dipolar sources will be canceled out, this
representation is sensitive to artifacts. If `~mne.Evoked`, butterfly
traces for signals before and after cleaning will be superimposed.
exclude : array-like of int | None (default)
The components marked for exclusion. If None (default), ICA.exclude
The components marked for exclusion. If ``None`` (default), ICA.exclude
will be used.
%(picks_base)s all channels that were included during fitting.
start : int | None
X-axis start index. If None (default) from the beginning.
stop : int | None
X-axis stop index. If None (default) to 3.0s.
title : str
The figure title.
show : bool
Show figure if True.
start, stop : float | None
The first and last time point (in seconds) of the data to plot. If
``inst`` is a `~mne.io.Raw` object, ``start=None`` and ``stop=None``
will be translated into ``start=0.`` and ``stop=3.``, respectively. For
`~mne.Evoked`, ``None`` refers to the beginning and end of the evoked
signal.
%(title_None)s
%(show)s
%(n_pca_components_apply)s

.. versionadded:: 0.22
Expand Down