eelbrain.plot.brain.cluster¶
-
eelbrain.plot.brain.
cluster
(cluster, vmax=None, *args, **kwargs)¶ Plot a spatio-temporal cluster
Plots a cluster with the assumption that all non-zero data should be visible, while areas that not part of the cluster are 0.
Parameters: - cluster : NDVar
The cluster.
- vmax : scalar != 0
Maximum value in the colormap. Default is the maximum value in the cluster.
- surf : ‘inflated’ | ‘pial’ | ‘smoothwm’ | ‘sphere’ | ‘white’
Freesurfer surface to use as brain geometry.
- views : str | iterator of str
View or views to show in the figure. Options are: ‘rostral’, ‘parietal’, ‘frontal’, ‘ventral’, ‘lateral’, ‘caudal’, ‘medial’, ‘dorsal’.
- hemi : ‘lh’ | ‘rh’ | ‘both’ | ‘split’
Which hemispheres to plot (default based on data).
- colorbar : bool
Add a colorbar to the figure (use
.plot_colorbar()
to plot a colorbar separately).- time_label : str
Label to show time point. Use
'ms'
or's'
to display time in milliseconds or in seconds, or supply a custom format string to format time values (in seconds; default is'ms'
).- w, h, axw, axh : scalar
Layout parameters (figure width/height, subplot width/height).
- foreground : mayavi color
Figure foreground color (i.e., the text color).
- background : mayavi color
Figure background color.
- parallel : bool
Set views to parallel projection (default
True
).- cortex : str | tuple | dict
Mark gyri and sulci on the cortex. Presets:
'classic'
(default),'high_contrast'
,'low_contrast'
,'bone'
. Can also be a single color (e.g.'red'
,(0.1, 0.4, 1.)
) or a tuple of two colors for gyri and sulci (e.g.['red', 'blue']
or[(1, 0, 0), (0, 0, 1)]
). For all options see the PySurfer documentation.- title : str
title for the window (default is the subject name).
- smoothing_steps : None | int
Number of smoothing steps if data is spatially undersampled (pysurfer
Brain.add_data()
argument).- mask : bool | matplotlib color
Shade areas that are not in
cluster
. Can be matplotlib color, including alpha (e.g.,(1, 1, 1, 0.5)
for semi-transparent white).- subjects_dir : None | str
Override the subjects_dir associated with the source space dimension.
- name : str
Equivalent to
title
, for consistency with other plotting functions.
Returns: - brain : surfer.Brain
PySurfer Brain instance containing the plot.