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.

7.12.2. nilearn.surface.load_surf_mesh

nilearn.surface.load_surf_mesh(surf_mesh)

Loading a surface mesh geometry

Parameters:

surf_mesh : str or numpy.ndarray

Either a file containing surface mesh geometry (valid formats are .gii or Freesurfer specific files such as .orig, .pial, .sphere, .white, .inflated) or a list of two Numpy arrays, the first containing the x-y-z coordinates of the mesh vertices, the second containing the indices (into coords) of the mesh faces.

Returns:

[coords, faces] : List of two numpy.ndarray

The first containing the x-y-z coordinates of the mesh vertices, the second containing the indices (into coords) of the mesh faces.