render: plot or save the results of meshDist

View source: R/meshDist.r

renderR Documentation

plot or save the results of meshDist

Description

plot or save the results of meshDist

Usage

render(x, ...)

## S3 method for class 'meshDist'
render(
  x,
  from = NULL,
  to = NULL,
  steps = NULL,
  ceiling = NULL,
  uprange = NULL,
  tol = NULL,
  tolcol = NULL,
  rampcolors = NULL,
  NAcol = NULL,
  displace = FALSE,
  shade = TRUE,
  sign = NULL,
  add = FALSE,
  scaleramp = NULL,
  titleplot = "Distance in mm",
  ...
)

## S3 method for class 'matrixDist'
render(
  x,
  from = NULL,
  to = NULL,
  steps = NULL,
  ceiling = NULL,
  uprange = NULL,
  tol = NULL,
  tolcol = NULL,
  type = c("s", "p"),
  radius = NULL,
  rampcolors = NULL,
  NAcol = NULL,
  displace = FALSE,
  sign = NULL,
  add = FALSE,
  scaleramp = FALSE,
  titleplot = "Distance in mm",
  ...
)

export(x, ...)

## S3 method for class 'meshDist'
export(
  x,
  file = "default",
  imagedim = "100x800",
  titleplot = "Distance in mm",
  ...
)

Arguments

x

object of class meshDist

...

for render.meshDist: additional arguments passed to shade3d. See material3d for details.

from

numeric: minimum distance to color; default is set to 0 mm

to

numeric: maximum distance to color; default is set to the maximum distance

steps

integer: determines how many intermediate colors the color ramp has.

ceiling

logical: if TRUE, the next larger integer of "to" is used

uprange

numeric between 0 and 1: restricts "to" to a quantile of "to", if to is NULL.

tol

numeric: threshold to color distances within this threshold according to tolcol.

tolcol

a custom color to color vertices below a threshold defined by tol. Default is green.

rampcolors

character vector: specify the colors which are used to create a colorramp.

NAcol

character: specify color for values outside the range defined by from and to.

displace

logical: if TRUE, displacement vectors between original and closest points are drawn colored according to the distance.

shade

logical: if FALSE, the rendering of the colored surface will be supressed.

sign

logical: request signed distances to be visualised.

add

logical: if TRUE, visualization will be added to the rgl window currently in focus

scaleramp

if TRUE the ramp colors get scaled symmetrically into positive and negative direction.

titleplot

character: axis description of heatmap.

type

character: "s" shows coordinates as spheres, while "p" shows 3D dots.

radius

determines size of spheres; if not specified, optimal radius size will be estimated by centroid size of the configuration.

file

character: filename for mesh and image files produced. E.g. "mydist" will produce the files mydist.ply and mydist.png

imagedim

character of pattern "100x200" where 100 determines the width and 200 the height of the image.

Details

Visualise or save the results of meshDist to disk.

render.meshDist renders the colored mesh and displays the color ramp and returns an object of class "meshDist". export.meshDist exports the colored mesh as ply file and the color chart as png file.

Author(s)

Stefan Schlager

See Also

meshDist, shade3d


Morpho documentation built on June 22, 2024, 7:19 p.m.