NeuroSurface: Construct a NeuroSurface Object

In bbuchsbaum/neurosurf: Data structures and visualization for surface-based neuroimaging data

Construct a NeuroSurface Object

Description

This function creates a new NeuroSurface object, which represents a single set of data values associated with nodes on a surface geometry.

Usage

NeuroSurface(geometry, indices, data)

Arguments

geometry	A SurfaceGeometry object representing the underlying surface structure.
indices	An integer vector specifying the indices of valid surface nodes.
data	A numeric vector of data values corresponding to the surface nodes.

Details

The NeuroSurface object is designed to store and manipulate a single set of data values associated with nodes on a surface. This can represent various neuroimaging measures such as cortical thickness, functional activation, or any other node-wise metric.

The length of the data vector should match the length of the indices vector. Nodes not included in the indices vector are considered to have no data or to be invalid.

Value

A new object of class NeuroSurface containing:

geometry	The input SurfaceGeometry object.
indices	The input integer vector of valid node indices.
data	The input numeric vector of data values.

See Also

SurfaceGeometry, NeuroSurfaceVector

Examples

# Assuming 'surf_geom' is a pre-existing SurfaceGeometry object
indices <- 1:1000  # Example indices
data_values <- rnorm(1000)  # Example data
neuro_surf <- NeuroSurface(surf_geom, indices, data_values)

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