netneurotools.plotting.plot_fsvertex

netneurotools.plotting.plot_fsvertex(data, *, order='lr', surf='pial', views='lat', vmin=None, vmax=None, center=None, mask=None, colormap='viridis', colorbar=True, alpha=0.8, label_fmt='%.2f', num_labels=3, size_per_view=500, subject_id='fsaverage', subjects_dir=None, data_kws=None, **kwargs)[source]

Plot vertex-wise data to fsaverage brain.

Parameters:

  • data ((N,) array_like) – Data for N parcels as defined in annot

  • order ({'lr', 'rl'}, optional) – Order of the hemispheres in the data vector. Default: ‘lr’

  • surf (str, optional) – Surface on which to plot data. Default: ‘pial’

  • views (str or list, optional) – Which views to plot of brain. Default: ‘lat’

  • vmin (float, optional) – Minimum value for colorbar. If not provided, a robust estimation will be used from values in data. Default: None

  • vmax (float, optional) – Maximum value for colorbar. If not provided, a robust estimation will be used from values in data. Default: None

  • center (float, optional) – Center of colormap, if desired. Default: None

  • mask ((N,) array_like, optional) – Binary array where entries indicate whether values in data should be masked from plotting (True = mask; False = show). Default: None

  • colormap (str, optional) – Which colormap to use for plotting data. Default: ‘viridis’

  • colorbar (bool, optional) – Whether to display the colorbar in the plot. Default: True

  • alpha ([0, 1] float, optional) – Transparency of plotted data. Default: 0.8

  • label_fmt (str, optional) – Format of colorbar labels. Default: ‘%.2f’

  • number_of_labels (int, optional) – Number of labels to display on colorbar. Default: 3

  • size_per_view (int, optional) – Size, in pixels, of each frame in the plotted display. Default: 1000

  • subjects_dir (str, optional) – Path to FreeSurfer subject directory. If not set, will inherit from the environmental variable $SUBJECTS_DIR. Default: None

  • subject (str, optional) – Subject ID to use; must be present in subjects_dir. Default: ‘fsaverage’

  • data_kws (dict, optional) – Keyword arguments for Brain.add_data()

Returns:

brain – Plotted PySurfer brain

Return type:

surfer.Brain