fsbrain (version 0.4.2)

annot.outline: Compute outline vertex colors from annotation.

Description

For each region in an atlas, compute the outer border and color the respective vertices in the region-specific color from the annot's colortable.

Usage

annot.outline(
  annotdata,
  surface_mesh,
  background = "white",
  silent = TRUE,
  expand_inwards = 0L,
  outline_color = NULL,
  limit_to_regions = NULL
)

Arguments

annotdata

an annotation, as returned by functions like subject.annot.

surface_mesh

brain surface mesh, as returned by functions like subject.surface or read.fs.surface.

background

color, the background color to assign to the non-border parts of the regions. Defaults to 'white'.

silent

logical, whether to suppress status messages.

expand_inwards

integer, additional thickness of the borders. Increases computation time, defaults to 0L.

outline_color

NULL or a color string (like 'black' or '#000000'), the color to use for the borders. If left at the default value `NULL`, the colors from the annotation color lookup table will be used.

limit_to_regions

vector of character strings or NULL, a list of regions for which to draw the outline (see get.atlas.region.names). If NULL, all regions will be used. If (and only if) this parameter is used, the 'outline_color' parameter can be a vector of color strings, one color per region.

Value

vector of colors, one color for each mesh vertex