mne.viz.set_3d_backend

mne.viz.set_3d_backend(backend_name, verbose=None)

Set the backend for MNE.

The backend will be set as specified and operations will use that backend.

Parameters

backend_namestr

The 3d backend to select. See Notes for the capabilities of each backend.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Notes

This table shows the capabilities of each backend (“✓” for full support, and “-” for partial support):

3D function:	mayavi	pyvista
plot_vector_source_estimates()	✓	✓
plot_source_estimates()	✓	✓
plot_alignment()	✓	✓
plot_sparse_source_estimates()	✓	✓
plot_evoked_field()	✓	✓
plot_sensors_connectivity()	✓	✓
snapshot_brain_montage()	✓	✓
link_brains()		✓
3D feature:
Large data	✓	✓
Opacity/transparency	✓	✓
Support geometric glyph	✓	✓
Jupyter notebook	✓	✓
Interactivity in Jupyter notebook	✓	✓
Smooth shading	✓	✓
Subplotting	✓	✓
Save offline movie	✓	✓
Point picking		✓

Note

In the case of plot_vector_source_estimates with PyVista, the glyph size is not consistent with Mayavi, it is also possible that a dark filter is visible on the mesh when depth peeling is not available.

Examples using mne.viz.set_3d_backend