total_branch_length_qsm: Total branch length TreeQSM

View source: R/basic_metrics_qsm.R

total_branch_length_qsmR Documentation

Total branch length TreeQSM

Description

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

Usage

total_branch_length_qsm(treedata)

Arguments

treedata

Treedata field of a TreeQSM that is returned by read_tree_qsm.

Value

The total branch length of the TreeQSM in meters.

Examples

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

## End(Not run)

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