resolve_brain_mesh: Resolve brain surface mesh

View source: R/brain-mesh.R

resolve_brain_meshR Documentation

Resolve brain surface mesh

Description

Resolves and prepares a brain surface mesh for rendering. Delegates to [ggseg.formats::get_brain_mesh()] for inflated surfaces and to [ggseg.meshes::get_cortical_mesh()] for pial, white, semi-inflated, and other surfaces. Returned meshes use the shared anatomical axis convention ('x' = left-right, 'y' = anterior-posterior, 'z' = superior-inferior) with 'lh' positioned at 'x <= 0' and 'rh' at 'x >= 0', medial edges meeting at the midline ('x = 0').

Usage

resolve_brain_mesh(
  hemisphere = c("lh", "rh"),
  surface = c("inflated", "semi-inflated", "white", "pial", "sphere", "smoothwm", "orig"),
  brain_meshes = NULL
)

Arguments

hemisphere

'"lh"' or '"rh"'

surface

Surface type: '"inflated"', '"semi-inflated"', '"white"', '"pial"', '"sphere"', '"smoothwm"', '"orig"'

brain_meshes

Optional user-supplied mesh data. Passed through to [ggseg.formats::get_brain_mesh()] for format details.

Value

list with vertices (data.frame with x, y, z) and faces (data.frame with i, j, k), or NULL if mesh not found

Examples

mesh <- resolve_brain_mesh("lh", "inflated")
str(mesh, max.level = 1)


ggseg3d documentation built on April 22, 2026, 5:09 p.m.