neuromodes.io.fetch_surf

neuromodes.io.fetch_surf(species: str = 'human', density: str = '32k', hemi: str = 'L', surf_type: str = 'midthickness', template: str = 'fsLR') → Tuple[Trimesh, NDArray]

Load a cortical triangular surface mesh and medial wall mask from neuromodes data directory. For a list of available surfaces, see https://github.com/NSBLab/neuromodes/tree/main/neuromodes/data/included_data.csv.

Parameters

speciesstr, optional

Species of the surface mesh. Options include ‘human’, ‘macaque’, and ‘marmoset’. Default is ‘human’.

densitystr, optional

Density of the surface mesh. Options include ‘32k’ for all species, and ‘4k’ for human. Default is ‘32k’.

hemistr, optional

Hemisphere of the surface mesh. Options are ‘L’ for all species, and ‘R’ for human. Default is ‘L’.

surf_typestr, optional

Surface type to load. Currently only supports ‘midthickness’. Default is ‘midthickness’.

templatestr, optional

Template of the surface mesh. Currently only supports ‘fsLR’. Default is ‘fsLR’.

Returns

surftrimesh.Trimesh

The loaded surface mesh.

medmasknp.ndarray

The medial wall mask as a boolean array.

Raises

ValueError

If the specified surface data is not found in the neuromodes/data directory.