qsm_summary {rTwig}

QSM Summary

Description

Generates summaries of QSM features (e.g. volume, surface area, dbh, etc.) by totals and branch order

Usage

qsm_summary(cylinder, radius = "modified", triangulation = FALSE)

Arguments

cylinder

QSM cylinder data frame

radius

Radius type as either "modified", "unmodified", or "old". Defaults to "modified".

triangulation

QSM triangulation list. Defaults to FALSE.

Value

Returns a list

Examples

## TreeQSM Processing Chain
file <- system.file("extdata/QSM.mat", package = "rTwig")
qsm <- import_qsm(file)
cylinder <- qsm$cylinder
cylinder <- update_cylinders(cylinder)
qsm_summary(cylinder)

# TreeQSM Triangulation
file <- system.file("extdata/QSM.mat", package = "rTwig")
qsm <- import_qsm(file)
cylinder <- qsm$cylinder
cylinder <- update_cylinders(cylinder)
triangulation <- qsm$triangulation
qsm_summary(cylinder = cylinder, triangulation = triangulation)

## SimpleForest Processing Chain
file <- system.file("extdata/QSM.csv", package = "rTwig")
cylinder <- read.csv(file)
cylinder <- update_cylinders(cylinder)
qsm_summary(cylinder)