visbrain.objects.BrainObj.parcellize¶

BrainObj.parcellize(file, select=None, hemisphere=None, data=None, cmap='viridis', clim=None, vmin=None, under='gray', vmax=None, over='red')[source][source]¶

Parcellize the brain surface using a .annot file.

This method require the nibabel package to be installed.

Parameters:

Parameters:	file : string Path to the .annot file. select : array_like \| None Select the structures to display. Use either a list a index or a list of structure’s names. If None, all structures are displayed. hemisphere : string \| None The hemisphere for the parcellation. If None, the hemisphere will be inferred from file name. data : array_like \| None Use data to be transformed into color for each parcellate. cmap : string \| ‘viridis’ The colormap to use. clim : tuple \| None The colorbar limits. If None, (data.min(), data.max()) will be used instead. vmin : float \| None Minimum threshold. vmax : float \| None Maximum threshold. under : string/tuple/array_like \| ‘gray’ The color to use for values under vmin. over : string/tuple/array_like \| ‘red’ The color to use for values over vmax.

file : string: Path to the .annot file.
select : array_like | None: Select the structures to display. Use either a list a index or a list of structure’s names. If None, all structures are displayed.
hemisphere : string | None: The hemisphere for the parcellation. If None, the hemisphere will be inferred from file name.
data : array_like | None: Use data to be transformed into color for each parcellate.
cmap : string | ‘viridis’: The colormap to use.
clim : tuple | None: The colorbar limits. If None, (data.min(), data.max()) will be used instead.
vmin : float | None: Minimum threshold.
vmax : float | None: Maximum threshold.
under : string/tuple/array_like | ‘gray’: The color to use for values under vmin.
over : string/tuple/array_like | ‘red’: The color to use for values over vmax.