mne_denoise.viz.plot_condition_interaction_summary#

mne_denoise.viz.plot_condition_interaction_summary(traces, times, errors=None, condition_order=None, group_order=None, group_colors=None, group_labels=None, windows=None, title='Condition Interaction Summary', show=True, fname=None)[source]#

Plot condition-by-group interaction traces.

Parameters:

  • traces (mapping[str, mapping[str, array-like]]) – Nested mapping condition -> group -> trace.

  • times (array-like of shape (n_times,)) – Explicit time axis.

  • errors (mapping | None) – Optional nested mapping condition -> group -> standard error.

  • condition_order (sequence of str | None) – Optional condition order. Defaults to first-seen order.

  • group_order (sequence of str | None) – Optional group order. Defaults to first-seen order across conditions.

  • group_colors (mapping | None) – Optional color/label overrides keyed by group.

  • group_labels (mapping | None) – Optional color/label overrides keyed by group.

  • windows (sequence of tuple[float, float, str] | None) – Optional highlighted windows as explicit (start, stop, label) tuples.

  • title (str) – Figure title.

  • show (bool) – Whether to show the figure.

  • fname (path-like | None) – Optional output path.

Returns:

fig – Figure handle.

Return type:

matplotlib.figure.Figure

Raises:

ValueError – If traces is empty, times is not 1D, or trace/error arrays do not match the expected time dimension.

Notes

Conditions are rendered as separate panels and groups as overlaid lines within each panel.

Examples

>>> import numpy as np
>>> from mne_denoise.viz import plot_condition_interaction_summary
>>> times = np.linspace(-0.2, 0.5, 300)
>>> traces = {
...     "A": {"before": np.sin(times), "after": 0.7 * np.sin(times)},
...     "B": {"before": np.cos(times), "after": 0.6 * np.cos(times)},
... }
>>> fig = plot_condition_interaction_summary(
...     traces,
...     times=times,
...     windows=[(0.08, 0.14, "w1")],
...     show=False,
... )