3D Surface plotter — plot_surf3d • VertexWiseR

Plots 3D cortical surfaces

Usage

plot_surf3d(
  surf_data,
  surf_color = "grey",
  cmap,
  limits,
  atlas = 1,
  hemi = "b",
  medial_gap = 0,
  orientation_labels = TRUE,
  VWR_check = TRUE,
  plot_grid = TRUE,
  transparent_bg = FALSE
)

Arguments

surf_data: A numeric vector (length of V)
surf_color: color of the cortical surface. Set to 'grey' by default
cmap: A string vector containing 2 to 4 color names/codes specifying the colors to be used for the color scale; or a single string object with the name of a color map listed in RColorBrewer::display.brewer.all(). If none are specified, appropriate colors will be automatically selected according to range(surf_data)
limits: A combined pair of numeric vector composed of the lower and upper color scale limits of the plot. When left unspecified, the symmetrical limits c(-max(abs(surf_dat),max(abs(surf_dat))) will be used.
atlas: atlas used for identifying region labels. 1=Desikan, 2=Destrieux-148, 3=Glasser-360, 4=Schaefer-100, 5=Schaefer-200, 6=Schaefer-400. Set to 1 by default. This argument is ignored for hippocampal surfaces.
hemi: A string specifying the hemisphere to plot. Possible values are l (left), r (right) or b (both).
medial_gap: A numeric value specifying the amount of gap (in MNI coordinate units) to separate the left and right hemispheres. Set to 0 (no gap between hemispheres) by default. In order to view the medial surfaces clearly, it is recommended that this value is set to 20. This argument is ignored if hemi!='b'
orientation_labels: A boolean object specifying if orientation labels are to be displayed. Set to TRUE by default
VWR_check: A boolean object specifying whether to check and validate system requirements. Default is TRUE.
plot_grid: A boolean object specifying whether to plot the orientation grid or not (default is TRUE).
transparent_bg: A boolean object specifying whether to get a transparent background upon saving the image (default is FALSE, white background).

Value

a plot_ly object

Examples

surf_data = runif(20484);
plot_surf3d(surf_data = surf_data, VWR_check=FALSE)