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.SurfaceImage

class nilearn.experimental.surface.SurfaceImage(mesh, data)[source]

Surface image, usually containing meshes & data for both hemispheres.

__init__(mesh, data)[source]

Create a SurfaceImage instance.

Parameters:
meshPolyMesh | dict[str, Mesh | str | Path]
dataPolyData | dict[str, Mesh | str | Path] | Niimg-like object
to_filename(filename)[source]

Save mesh to gifti.

Parameters:
filenamestr | Path

If the filename contains hemi-L then only the left part of the mesh will be saved. If the filename contains hemi-R then only the right part of the mesh will be saved. If the filename contains neither of those, then _hemi-L and _hemi-R will be appended to the filename and both will be saved.

Examples using nilearn.experimental.surface.SurfaceImage

Surface-based dataset first and second level analysis of a dataset

Surface-based dataset first and second level analysis of a dataset

Example of surface-based first-level analysis

Example of surface-based first-level analysis

Loading and plotting of a cortical surface atlas

Loading and plotting of a cortical surface atlas

A short demo of the surface images & maskers

A short demo of the surface images & maskers

Seed-based connectivity on the surface

Seed-based connectivity on the surface

Making a surface plot of a 3D statistical map

Making a surface plot of a 3D statistical map