TreeStatistics Class Documentation#

Package: sc.fiji.snt.analysis

Computes summary and descriptive statistics from properties of Paths and Nodes in a Tree, including convenience methods to plot distributions of such data. For analysis of groups of Trees have a look at MultiTreeStatistics and GroupedTreeStatistics.

Methods#

Getters Methods#

static getAllMetrics()

Gets the list of supported metrics.

getAnnotatedLength(int, String)#

Retrieves the amount of cable length present on each brain compartment innervated by the analyzed neuron.

getAnnotatedLengthHistogram(int)#

Retrieves the histogram of cable length frequencies across brain areas of the specified ontology level across the specified hemisphere.

getAnnotatedLengthsByHemisphere(int)#

Retrieves the amount of cable length present on each brain compartment innervated by the analyzed neuron in the two brain hemispheres. Lengths are absolute and not normalized to the cells’ cable length.

getAnnotations(int)#

Retrieves the brain compartments (neuropil labels) associated with the Tree being measured innervated by the analyzed neuron.

getAvgBranchLength()#

Gets average length for all the branches of the analyzed tree.

getAvgContraction()#

Gets average contraction for all the branches of the analyzed tree.

getAvgFractalDimension()#

Gets the average fractal dimension of the analyzed tree. Note that branches with less than 5 points are ignored during the computation.

getAvgFragmentation()#

Gets the average no. of nodes (fragmentation) for all the branches of the analyzed tree.

getAvgPartitionAsymmetry()#

Gets the average partition asymmetry of the analyzed tree. Note that branch points with more than 2 children are ignored during the computation.

getAvgRemoteBifAngle()#

Gets the average remote bifurcation angle of the analyzed tree. Note that branch points with more than 2 children are ignored during the computation.

getBranchPoints(BrainAnnotation, boolean)#

Gets the position of all the branch points in the analyzed tree associated with the specified annotation.

getBranches()#

Gets all the branches in the analyzed tree. A branch is defined as the Path composed of all the nodes between two branching points or between one branching point and a termination point.

getCableLength(BrainAnnotation)#

Gets the cable length associated with the specified compartment (neuropil label).

getCableLengthNorm(BrainAnnotation)#

Gets the cable length associated with the specified compartment (neuropil label) as a ratio of total length.

getCancelReason()#
getContext()#
getConvexAnalyzer()#

Gets the ConvexHullAnalyzer instance associated with this TreeStatistics instance.

getConvexHullMetric(String)#

Convenience method to obtain a single-value metric from ConvexHullAnalyzer

getDepth()#

Returns the depth of the BoundingBox box of the tree being measured

getDescriptiveStats(String)#

Computes the DescriptiveStatistics for the specified measurement.

getFlowPlot(String, Collection)#

Assembles a Flow plot (aka Sankey diagram) for the specified feature.

getFractalDimension()#

Gets the fractal dimension of each branch in the analyzed tree. Note that branches with less than 5 points are ignored.

getHeight()#

Returns the height of the BoundingBox box of the tree being measured

getHighestPathOrder()#

Gets the highest path order of the analyzed tree

getHistogram(String)#

Retrieves the histogram of relative frequencies histogram for a univariate measurement. The number of bins is determined using the Freedman-Diaconis rule.

getInnerBranches()#

Retrieves the branches of highest Strahler order in the Tree. This typically correspond to the most ‘internal’ branches of the Tree in direct sequence from the root.

getInnerLength()#

Gets the cable length of inner branches

getMetric(String)#

Computes the specified metric.

static getMetrics(String)

Gets the list of most commonly used metrics.

getNBranchPoints(BrainAnnotation)#

Gets the number of branch points in the analyzed tree associated with the specified annotation.

Other Methods#

cancel(String)#

Sets the table for this TreeStatistics instance.

context()#
dispose()#

Clears internal caches and mappings to free memory.

static fromCollection(Collection, String)

Creates a TreeStatistics instance from a group of Trees and a specific metric for convenient retrieval of histograms

See Also#