total_cyl_length_qsm: Total cylinder length TreeQSM

View source: R/basic_metrics_qsm.R

total_cyl_length_qsmR Documentation

Total cylinder length TreeQSM

Description

Extracts the total cylinder length from the treedata of a TreeQSM.

Usage

total_cyl_length_qsm(treedata)

Arguments

treedata

Treedata field of a TreeQSM that is returned by read_tree_qsm.

Value

The total length of all the cylinders (branch and trunk) of a TreeQSM in meters.

Examples

## Not run: 
# Read tree qsm and extract total cylinder length
qsm <- read_tree_qsm(QSM_path = "path/to/qsm.mat")
tot_len <- total_cyl_length_qsm(treedata = qsm$treedata)

## End(Not run)

lmterryn/ITSMe documentation built on Feb. 4, 2025, 2:21 a.m.