get-shape: Shape Characteristics of a Streamline

Description Usage Arguments Value Examples

Description

get_euclidean_length computes the Euclidean length of a streamline, which is the Euclidean distance between its endpoints. get_curvilinear_length computes the curvilinear length of a streamline, which is the range of its curvilinear abscissa. get_sinuosity computes the sinuosity of a streamline, which is the ratio between its curvilinear and Euclidean lengths. get_curvature computes the curvature of a streamline along its curvilinear abscissa. get_curvature_max computes the maximal curvature of a streamline along its curvilinear abscissa. get_curvature_mean computes the mean curvature of a streamline along its curvilinear abscissa. get_curvature_sd computes the standard deviation of the curvature of a streamline along its curvilinear abscissa.

Usage

1
2
3
4
5
6
7
8
9
get_euclidean_length(streamline, validate = TRUE)

get_curvilinear_length(streamline, validate = TRUE)

get_sinuosity(streamline, validate = TRUE)

get_curvature(st, validate = TRUE, scalar = NULL)

get_torsion(st, validate = TRUE, scalar = NULL)

Arguments

streamline

A streamline.

validate

A boolean which is TRUE if the input type should be checked or FALSE otherwise (default: TRUE).

direction

String for choosing along which axis to compute the curvature (default: NULL which computes the 3D curvature)

Value

A scalar giving the desired shape characteristic of the input streamline, except for get_curvature which returns a tibble.

Examples

1
2
3
4
5
6
7
8
file <- system.file("extdata", "CC_SingleTensor.csv", package = "fiber")
cc <- read_tract(file)
st <- cc$data[[1]]
get_euclidean_length(st)
get_curvilinear_length(st)
get_sinuosity(st)
get_curvature(st)
get_torsion(st)

astamm/fdatractography documentation built on May 12, 2019, 5:37 a.m.