Adapt a neurosurf geometry to a surface feature space — surface_space_from

neurosurf remains the owner of mesh geometry and algorithms. This adapter extracts its stable topology, coordinates, hemisphere, and world transform into the backend-neutral identity required by an fmri_frame.

Usage

surface_space_from_neurosurf(
  geometry,
  vertex_ids = NULL,
  support = NULL,
  medial_wall = NULL,
  template = NULL,
  units = "mm",
  metadata = list()
)

Arguments

geometry: A neurosurf::SurfaceGeometry.
vertex_ids: Optional stable full-mesh vertex IDs.
support, medial_wall, template, units, metadata: Passed to surface_space().

Value

A surface_space.

Examples

if (requireNamespace("neurosurf", quietly = TRUE)) {
  old_rgl <- Sys.getenv("RGL_USE_NULL", unset = NA)
  Sys.setenv(RGL_USE_NULL = "TRUE")
  vertices <- matrix(c(0, 0, 0, 1, 0, 0, 0, 1, 0), ncol = 3, byrow = TRUE)
  geom <- neurosurf::SurfaceGeometry(
    vertices, matrix(c(0, 1, 2), nrow = 1), hemi = "lh", label = "pial"
  )
  x <- surface_space_from_neurosurf(geom, template = "toy-surface")
  feature_ids(x)
  if (is.na(old_rgl)) Sys.unsetenv("RGL_USE_NULL") else Sys.setenv(RGL_USE_NULL = old_rgl)
}