MRG: Add "highlight" parameter to Evoked.plot() to conveniently highlight time periods

[hoechenberger]

Allows to conveniently produce figures like:

Becomes really powerful when combined with Evoked.plot_topomap()'s average parameter:

MWE:

# %%
from pathlib import Path
import mne


sample_dir = Path(mne.datasets.sample.data_path())
sample_fname = sample_dir / 'MEG' / 'sample' / 'sample_audvis_raw.fif'

raw = mne.io.read_raw_fif(sample_fname)
raw.crop(tmax=60)

events = mne.find_events(raw, stim_channel='STI 014')
event_id = {'auditory/left': 1, 'auditory/right': 2, 'visual/left': 3,
            'visual/right': 4, 'face': 5, 'buttonpress': 32}

epochs = mne.Epochs(raw, events=events, event_id=event_id,
                    tmin=-0.2, tmax=0.5, baseline=(None, 0),
                    preload=True)

evoked = epochs.average()

evoked.plot(
    spatial_colors=True, picks='mag', gfp=True,
    highlight=[(0.05, 0.13), (0.23, 0.3)]
);
evoked.plot_joint(
    times=[0.09],
    topomap_args=dict(average=0.1),
    ts_args=dict(highlight=(0.04, 0.14)),
    picks='mag'
);

[agramfort]

any idea why it's not taking the full y range?

[hoechenberger]

any idea why it's not taking the full y range?

Nope, it might be that we're doing some axis-range foo somewhere which I've overlooked. Any help on this would be appreciated! But I think even like it is now it's a step forward :)

[agramfort]

fix pushed

…

Message ID: ***@***.***>

[hoechenberger]

Amazing!!!!!

[hoechenberger]

Rendered tutorial:
https://output.circle-artifacts.com/output/job/4f2123f0-82d0-4f9e-a419-15b76f5e6d85/artifacts/0/dev/auto_tutorials/evoked/20_visualize_evoked.html#plotting-signal-traces

[hoechenberger]

@agramfort Please merge if happy

[agramfort]

anyone merge if happy.

thx @hoechenberger