mne.viz.create_3d_figure

mne.viz.create_3d_figure(size, bgcolor=(0, 0, 0), smooth_shading=True, handle=None, scene=True)[source]

Return an empty figure based on the current 3d backend.

Warning

Proceed with caution when the renderer object is returned (with scene=False) because the _Renderer API is not necessarily stable enough for production, it’s still actively in development.

Parameters
sizetuple

The dimensions of the 3d figure (width, height).

bgcolortuple

The color of the background.

smooth_shadingbool

If True, smooth shading is enabled. Defaults to True.

handleint | None

The figure identifier.

scenebool

Specify if the returned object is the scene. If False, the renderer object is returned. Defaults to True.

Returns
figureobject

The requested empty scene or the renderer object if scene=False.

mne.viz.set_3d_title mne.viz.get_brain_class