seglengths: Calculate length of all segments in neuron

Description Usage Arguments Details Value See Also Examples

View source: R/neuron.R

Description

Calculate length of all segments in neuron

Usage

1
seglengths(x, all = FALSE, flatten = TRUE, sumsegment = TRUE)

Arguments

x

A neuron

all

Whether to calculate lengths for all segments when there are multiple subtrees (default: FALSE)

flatten

Whether to flatten the lists of lists into a single list when all=TRUE

sumsegment

Whether to return the length of each segment (when sumsegment=TRUE, the default) or a list of vectors of lengths of each individual edge in the segment.

Details

A segment is an ubranched portion of neurite consisting of at least one vertex joined by edges.Only segments in x$SegList will be calculated unless all=TRUE. Segments containing only one point will have 0 length.

Value

A vector of lengths for each segment or when sumsegment=FALSE a list of vectors

See Also

as.seglist.neuron

Examples

1
2
3
summary(seglengths(Cell07PNs[[1]]))
hist(unlist(seglengths(Cell07PNs[[1]], sumsegment = FALSE)),
  br=20, main='histogram of edge lengths', xlab='edge lengths /microns')

nat documentation built on Sept. 6, 2021, 5:09 p.m.