Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

nilearn.surface.load_surf_data#

nilearn.surface.load_surf_data(surf_data)[source]#

Load data to be represented on a surface mesh.

Parameters:
surf_datastr, pathlib.Path, or numpy.ndarray

Either a file containing surface data (valid format are .gii, .gii.gz, .mgz, .nii, .nii.gz, or Freesurfer specific files such as .thickness, .curv, .sulc, .annot, .label), lists of 1D data files are returned as 2D arrays, or a Numpy array containing surface data.

Returns:
datanumpy.ndarray

An array containing surface data