summarise_qsm {rTwig} | R Documentation |
Summarise QSM
Description
Generates a simple QSM summary. The summary includes basic tree metrics, such as DBH, total height, and also volume and surface area arranged by totals and branching order.
Usage
summarise_qsm(cylinder, radius, triangulation = NULL)
summarize_qsm(cylinder, radius, triangulation = NULL)
Arguments
cylinder |
QSM cylinder data frame |
radius |
Radius column name either quoted or unquoted. |
triangulation |
Optional QSM triangulation list. Only supports TreeQSM. |
Details
summarise_qsm()
and summarize_qsm()
are synonyms.
Value
Returns a list
Examples
## SimpleForest Processing Chain
file <- system.file("extdata/QSM.csv", package = "rTwig")
cylinder <- read.csv(file)
cylinder <- update_cylinders(cylinder)
summarise_qsm(cylinder, radius)
# TreeQSM Triangulation
file <- system.file("extdata/QSM.mat", package = "rTwig")
qsm <- import_treeqsm(file)
cylinder <- qsm$cylinder
cylinder <- update_cylinders(cylinder)
summarise_qsm(cylinder, radius, triangulation = qsm$triangulation)
[Package rTwig version 1.4.0 Index]