Note

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

nilearn.experimental.surface.FileMesh#

class nilearn.experimental.surface.FileMesh(file_path)[source]#

A surface mesh stored in a Gifti or Freesurfer file.

__init__(file_path)[source]#

file_path#

n_vertices#

property coordinates#: Get x, y, z, values for each mesh vertex.

property faces#: Get array of adjacent vertices.

loaded()[source]#: Load surface mesh into memory.

to_gifti(gifti_file)[source]#

Write surface mesh to a Gifti file on disk.

Parameters:

gifti_filepath-like or str: filename to save the mesh.