molaR (version 4.5)

RFI3d: Plot 3D and 2D areas of a mesh used to calculate relief index

Description

A function that plots a three-dimensional model of the mesh surface and includes a footprint of the two-dimensional area for visual comparison.

Usage

RFI3d(
  RFI_Output,
  displacement = -1.9,
  SurfaceColor = "gray",
  FootColor = "red",
  FootPts = FALSE,
  FootPtsColor = "black",
  Opacity = 1,
  legend = F,
  legendScale = 1,
  leftOffset = 0,
  fieldofview = 0
)

Arguments

RFI_Output

An object that stores the output of the RFI function

displacement

Moves the surface footprint some proportion of the height of the mesh. 0 is no displacement. Expects a value, negative values displace the footprint downward.

SurfaceColor

changes the color of the 3D surface mesh

FootColor

changes color of the 2D surface footprint

FootPts

logical indicating whether to plot the flattened points of the footprint from the original ply file

FootPtsColor

color for the plotted footprint points

Opacity

adjusts the opacity of the 3D mesh surface

legend

Logical indicating whether or not to include a legend of the colors chosen to represent the 3D surface and footprint

legendScale

cex style numeric relative scaling factor for the legend

leftOffset

how numeric between -1 and 1 for which to offset the surface relative to the legend.

fieldofview

Passes an argument to par3d changing the field of view in degrees of the resulting rgl window.

Details

This function can help to visualize the three-dimensional and two dimensional areas that are used in calculating the relief index of a surface by displaying both at the same time. The RFI function must be performed first.

Opacity can be adjusted in a range from fully opaque (1) to fully transparent (0) in order to help visualize the footprint. The vertical placement of the footprint along the Z axis can be altered with displace depending on how the user wishes to view the surface, or on the original mesh orientation.

fieldofview is set to a default of 0, which is an isometric projection. Increasing it alters the degree of parallax in the perspective view, up to a maximum of 179 degrees.

Examples

# NOT RUN {
RFI_output <- RFI(Tooth, alpha=0.5)
RFI3d(RFI_output)
# }