visbrain.gui.Brain¶

class visbrain.gui.Brain(bgcolor='black', verbose=None, **kwargs)[source][source]¶

Visualization of brain-data on a standard MNI brain.

By default the Brain module display a standard MNI brain. Then, this brain can interact with several objects :

Brain (visbrain.objects.BrainObj)

Sources (visbrain.objects.SourceObj)

Connectivity (visbrain.objects.ConnectObj)

Time-series (visbrain.objects.TimeSeries3DObj)

Pictures (visbrain.objects.Picture3DObj)

Vectors (visbrain.objects.VectorObj)

Volume (visbrain.objects.VolumeObj)

Cross-sections (visbrain.objects.CrossSecObj)

Region Of Interest (visbrain.objects.RoiObj)

Alternatively, if an other brain template is needed, a brain object (BrainObj) can also be used (see brain_obj).

Parameters:

brain_objvisbrain.objects.BrainObj | None: A brain object.
vol_objvisbrain.objects.VolumeObj | None: A volume object.
cross_sec_objvisbrain.objects.CrossSecObj | None: A cross-sections object.
roi_objvisbrain.objects.RoiObj | None: A Region Of Interest (ROI) object.
source_objvisbrain.objects.SourceObj | None: An object (or list of objects) of type source.
connect_objvisbrain.objects.ConnectObj | None: An object (or list of objects) of type connectivity.
time_series_objvisbrain.objects.TimeSeries3DObj | None: An object (or list of objects) of type time-series.
picture_objvisbrain.objects.Picture3DObj | None: An object (or list of objects) of type pictures.
vector_objvisbrain.objects.VectorObj | None: An object (or list of objects) of type vector.
project_radiusfloat | 10.: The projection radius to use.
project_type{‘activity’, ‘repartition’}: Define the projection type. Use ‘activity’ to project the source’s activity or ‘repartition’ to get the number of contributing sources per vertex.
project_contributebool | False: Specify if source’s can contribute to both hemisphere during projection (True) or if it can only be projected on the hemisphere the source belong.
project_mask_colorstring/tuple/array_like | ‘orange’: The color to assign to vertex for masked sources.
project_cmapstring | ‘viridis’: The colormap to use for the source projection.
project_climtuple | (0., 1.): Colorbar limits of the projection.
project_vminfloat | None: Minimum threshold for the projection colorbar.
project_understring/tuple/array_like | ‘gray’: Color to use for values under project_vmin.
project_vmaxfloat | None: Maximum threshold for the projection colorbar.
project_overstring/tuple/array_like | ‘red’: Color to use for values over project_vmax.
bgcolorstring/tuple | ‘black’: Background color of the GUI.