MRG: Brain save movie

[GuillaumeFavelier]

This PR brings back the part of #7257 about save_movie in _Brain.

It's an item of #7162

[codecov]

Codecov Report

Merging #7574 into master will decrease coverage by 0.09%.
The diff coverage is 66.03%.

@@            Coverage Diff             @@
##           master    #7574      +/-   ##
==========================================
- Coverage   90.13%   90.04%   -0.10%     
==========================================
  Files         453      453              
  Lines       83280    83332      +52     
  Branches    13190    13204      +14     
==========================================
- Hits        75064    75034      -30     
- Misses       5369     5423      +54     
- Partials     2847     2875      +28     

[GuillaumeFavelier]

I intend to add compatibility with _TimeViewer in another PR so this is ready for reviews.

Also I typically use this feature with:

import os
import mne
from mne.datasets import sample
data_path = sample.data_path()
sample_dir = os.path.join(data_path, 'MEG', 'sample')
subjects_dir = os.path.join(data_path, 'subjects')
fname_stc = os.path.join(sample_dir, 'sample_audvis-meg')
stc = mne.read_source_estimate(fname_stc, subject='sample')
mne.viz.set_3d_backend('pyvista')
brain = stc.plot(subjects_dir=subjects_dir, hemi='lh',
                 clim=dict(kind='value', pos_lims=[3, 6, 9]),
                 time_viewer=False)
brain.save_movie('movie.mov', time_dilation=8.)

which requires imageio-ffmpeg, should I add it to the requirements too @larsoner, @agramfort ?

[agramfort]

can I save a movie from the interface? cmd+shift+ something?

…

[GuillaumeFavelier]

can I save a movie from the interface? cmd+shift+ something?

It's not possible in this PR. It focuses on time_viewer=False.

So do you mean to add it in this context?

[agramfort]

ok then this works as it is now.

…

[larsoner]

Yes +1 for adding it to requirements.txt and environment.yml

[GuillaumeFavelier]

I'll push a commit to add it right now.

[GuillaumeFavelier]

Failures on Circle don't seem related:

/home/circleci/project/doc/auto_tutorials/intro/plot_20_events_from_raw.rst:87: WARNING: term not in glossary: STIM channel

/home/circleci/project/doc/auto_tutorials/preprocessing/plot_60_maxwell_filtering_sss.rst:236: WARNING: term not in glossary: hpi

/home/circleci/project/doc/auto_tutorials/raw/plot_20_event_arrays.rst:43: WARNING: term not in glossary: STIM channel

I'll update after further investigation

[agramfort]

rebase on master?

…

[GuillaumeFavelier]

rebase on master?

Maybe.

[GuillaumeFavelier]

It's already up-to-date apparently.

[agramfort]

and master is green?

…

[GuillaumeFavelier]

and master is green?

AFAIK all is good and green there

[GuillaumeFavelier]

I restarted Circle for now

[agramfort]

@GuillaumeFavelier can you just update latest.inc ? thx

[agramfort]

thx @GuillaumeFavelier