- stc : SourceEstimates
The source estimates to plot.
- subject : str | None
The subject name corresponding to FreeSurfer environment
variable SUBJECT. If None stc.subject will be used. If that
is None, the environment will be used.
- surface : str
The type of surface (inflated, white etc.).
- hemi : str, ‘lh’ | ‘rh’ | ‘split’ | ‘both’
The hemisphere to display.
- colormap : str | np.ndarray of float, shape(n_colors, 3 | 4)
Name of colormap to use or a custom look up table. If array, must
be (n x 3) or (n x 4) array for with RGB or RGBA values between
0 and 255. Default is ‘hot’.
- time_label : str | callable | None
Format of the time label (a format string, a function that maps
floating point time values to strings, or None for no label). The
default is time=%0.2f ms
.
- smoothing_steps : int
The amount of smoothing
- transparent : bool | None
If True, use a linear transparency between fmin and fmid.
None will choose automatically based on colormap type. Has no effect
with mpl backend.
- alpha : float
Alpha value to apply globally to the overlay. Has no effect with mpl
backend.
- time_viewer : bool
Display time viewer GUI.
- subjects_dir : str
The path to the freesurfer subjects reconstructions.
It corresponds to Freesurfer environment variable SUBJECTS_DIR.
- figure : instance of mayavi.core.scene.Scene | instance of matplotlib.figure.Figure | list | int | None
If None, a new figure will be created. If multiple views or a
split view is requested, this must be a list of the appropriate
length. If int is provided it will be used to identify the Mayavi
figure by it’s id or create a new figure with the given id. If an
instance of matplotlib figure, mpl backend is used for plotting.
- views : str | list
View to use. See surfer.Brain(). Supported views: [‘lat’, ‘med’, ‘fos’,
‘cau’, ‘dor’ ‘ven’, ‘fro’, ‘par’]. Using multiple views is not
supported for mpl backend.
- colorbar : bool
If True, display colorbar on scene. Not available on mpl backend.
- clim : str | dict
Colorbar properties specification. If ‘auto’, set clim automatically
based on data percentiles. If dict, should contain:
kind
: ‘value’ | ‘percent’
Flag to specify type of limits.
lims
: list | np.ndarray | tuple of float, 3 elements
Note: Only use this if ‘colormap’ is not ‘mne’.
Left, middle, and right bound for colormap.
Unlike stc.plot
, it cannot use
pos_lims
, as the surface plot must show the magnitude.
- cortex : str or tuple
Specifies how binarized curvature values are rendered.
Either the name of a preset PySurfer cortex colorscheme (one of
‘classic’, ‘bone’, ‘low_contrast’, or ‘high_contrast’), or the name of
mayavi colormap, or a tuple with values (colormap, min, max, reverse)
to fully specify the curvature colors. Has no effect with mpl backend.
- size : float or pair of floats
The size of the window, in pixels. can be one number to specify
a square window, or the (width, height) of a rectangular window.
Has no effect with mpl backend.
- background : matplotlib color
Color of the background of the display window.
- foreground : matplotlib color
Color of the foreground of the display window. Has no effect with mpl
backend.
- initial_time : float | None
The time to display on the plot initially. None
to display the
first time sample (default).
- time_unit : ‘s’ | ‘ms’
Whether time is represented in seconds (“s”, default) or
milliseconds (“ms”).
- backend : ‘auto’ | ‘mayavi’ | ‘matplotlib’
Which backend to use. If 'auto'
(default), tries to plot with
mayavi, but resorts to matplotlib if mayavi is not available.
- spacing : str
The spacing to use for the source space. Can be 'ico#'
for a
recursively subdivided icosahedron, 'oct#'
for a recursively
subdivided octahedron, or 'all'
for all points. In general, you can
speed up the plotting by selecting a sparser source space. Has no
effect with mayavi backend. Defaults to ‘oct6’.