neuromaps.plotting.plot_surf_template

neuromaps.plotting.plot_surf_template(data, template, density, surf='inflated', hemi=None, data_dir=None, mask_medial=True, **kwargs)[source]

Plot data on template surface.

Parameters:

  • data (str or os.PathLike or tuple-of-str) – Path to data file(s) to be plotted. If tuple, assumes (left, right) hemisphere.

  • template ({'civet', 'fsaverage', 'fsLR'}) – Template on which data is defined

  • density (str) – Resolution of template

  • surf (str, optional) – Surface on which data should be plotted. Must be valid for specified space. Default: ‘inflated’

  • hemi ({'L', 'R'}, optional) – If data is not a tuple, which hemisphere it should be plotted on. Default: None

  • mask_medial (bool, optional) – Whether to mask vertices along the medial wall. Default: True

  • kwargs (key-value pairs) – Passed directly to nilearn.plotting.plot_surf

Returns:

fig – Plotted figure

Return type:

matplotlib.Figure instance