Skip to contents

Read Surface Geometry from File

Source: R/geometry.R
read_surf_geometry.Rd

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.

Value

A SurfaceGeometry object representing the loaded surface.

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.

Examples

# \donttest{
asc_path <- system.file("extdata", "std.8_lh.inflated.asc", package = "neurosurf")
lh_surface <- read_surf_geometry(asc_path)
#> loading /home/runner/work/_temp/Library/neurosurf/extdata/std.8_lh.inflated.asc
# }