VertexColoredNeuroSurface

This function creates a VertexColoredNeuroSurface object, which represents a surface with explicit colors assigned to each vertex.

Usage

VertexColoredNeuroSurface(geometry, indices, colors, data = NULL)

Arguments

geometry

A SurfaceGeometry object representing the underlying surface structure.

indices

An integer vector specifying the indices of valid surface nodes.

colors

A character vector of hex color codes for each vertex.

data

An optional numeric vector of data values. If not provided, defaults to zeros. This parameter exists for compatibility with the parent NeuroSurface class but is not used for coloring (colors are specified directly via the colors parameter).

Value

A VertexColoredNeuroSurface object containing the surface geometry with explicit vertex colors.

Details

This object represents a surface where each vertex has an explicitly assigned color, bypassing any data-to-color mapping. This is useful when you want direct control over vertex colors, such as when displaying parcellation results or pre-computed color schemes.

See also

SurfaceGeometry, NeuroSurface, ColorMappedNeuroSurface

Examples

# \donttest{
# Load a sample surface geometry
surf_file <- system.file("extdata", "std.8_lh.inflated.asc", package = "neurosurf")
surf_geom <- read_surf_geometry(surf_file)
#> loading /private/var/folders/9h/nkjq6vss7mqdl4ck7q1hd8ph0000gp/T/Rtmp0Nbniq/temp_libpath80e31f94425b/neurosurf/extdata/std.8_lh.inflated.asc

# Get first 100 vertices for this example
n_verts <- min(100, nrow(coords(surf_geom)))
vertex_indices <- 1:n_verts

# Create colors based on vertex coordinates (x-position)
x_coords <- coords(surf_geom)[vertex_indices, 1]
vertex_colors <- ifelse(x_coords > median(x_coords), "#FF6B6B", "#4ECDC4")

# Create the VertexColoredNeuroSurface object
colored_surf <- VertexColoredNeuroSurface(geometry = surf_geom,
                                          indices = vertex_indices,
                                          colors = vertex_colors)

# Print the object summary
print(colored_surf)
#> 
#>  NeuroSurface  
#> 
#>   Geometry & Data Mapping: 
#>   Hemisphere:         lh
#>   Total Vertices:   642
#>   Vertices w/ Data:100
#> 
#>   Data Summary: 
#>   Min:    0
#>   Median:0
#>   Mean:  0
#>   Max:    0
#> 

# The object can now be plotted with the specified colors
# plot(colored_surf) # Requires rgl package
# }