surfwidget-SurfaceGeometry-method: surfwidget

surfwidget,SurfaceGeometry-methodR Documentation

surfwidget

Description

Create a surfwidget to display brain surface data.

Usage

## S4 method for signature 'SurfaceGeometry'
surfwidget(
  x,
  width = NULL,
  height = NULL,
  data = NULL,
  cmap = rainbow(256),
  irange = NULL,
  thresh = c(0, 0),
  vertexColors = NULL,
  alpha = 1,
  config = list(),
  ...
)

Arguments

x

A SurfaceGeometry, NeuroSurface, ColorMappedNeuroSurface, or VertexColoredNeuroSurface object

width

The width of the widget

height

The height of the widget

data

Optional. Numeric vector of data values for each vertex.

cmap

Optional. Color map for data visualization.

irange

Optional. Intensity range for data visualization.

thresh

Optional. Threshold range for data visualization.

vertexColors

Optional. Vector of colors for each vertex.

alpha

Opacity of the surface (0 to 1).

config

A list of configuration options for the surface rendering:

  • shininessNumeric between 0 and 100. Controls the shininess of the material. Higher values create a more polished appearance. Default is 30.

  • specularColorCharacter. Hex color code for the specular highlights. Default is "#111111".

  • flatShadingLogical scalar. If TRUE, uses flat shading; if FALSE, uses smooth shading. Default is FALSE.

  • ambientLightColorCharacter. Hex color code for the ambient light. Default is "#404040".

  • directionalLightColorCharacter. Hex color code for the directional light. Default is "#ffffff".

  • directionalLightIntensityNumeric between 0 and 1. Intensity of the directional light. Default is 0.5.

Unknown elements are ignored with a warning.

Value

An HTMLWidget object


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