read_surf_geometry: Read Surface Geometry from File

View source: R/geometry.R

read_surf_geometryR Documentation

Read Surface Geometry from File

Description

This function loads a supported surface geometry from a file and returns a SurfaceGeometry object.

Usage

read_surf_geometry(surface_name)

Arguments

surface_name

A character string specifying the name of the file containing the surface geometry.

Details

This function supports loading surface geometries from the following file formats:

  • Freesurfer ASCII (.asc)

  • Freesurfer binary

  • GIFTI (.gii)

The appropriate loader is automatically selected based on the file extension or content.

Value

A SurfaceGeometry object representing the loaded surface.

Examples

## Not run: 
# Load a FreeSurfer surface
lh_surface <- read_surf_geometry("lh.pial")

# Load a GIFTI surface
rh_surface <- read_surf_geometry("rh.white.gii")

## End(Not run)



bbuchsbaum/neurosurf documentation built on June 10, 2025, 8:22 p.m.