CollapseBrances: Filter "small" branches

Description Usage Arguments Value

View source: R/AlterStructure.R

Description

Filter "small" branches

Usage

1
2
CollapseBrances(X, TargetPG, Mode = "PointNumber", ControlPar = 5,
  TrimmingRadius = Inf, PlotSelected = TRUE)

Arguments

X

numeric matrix, the data matrix

TargetPG

list, the ElPiGraph structure to extend

Mode

string, the mode used to extend the graph. "PointNumber", "PointNumber_Extrema", "PointNumber_Leaves", "EdgesNumber", and "EdgesLength" are currently implemented

ControlPar

positive numeric, the paramter used to control the contribution of the different data points

TrimmingRadius

positive numeric, the trimming radius used to control distance

PlotSelected

boolean, should a diagnostic plot be visualized (currently not implemented)

Value

a list with 2 values: Nodes (a matrix containing the new nodes positions) and Edges (a matrix describing the new edge structure)

The value of ControlPar has a different interpretation depending on the valus of Mode.

If Mode = "PointNumber", branches with less that ControlPar points projected on the branch (points projected on the extreme points are not considered) are removed

If Mode = "PointNumber_Extrema", branches with less that ControlPar points projected on the branch or the extreme points are removed

If Mode = "PointNumber_Leaves", branches with less that ControlPar points projected on the branch and any leaf points (points projected on non-leaf extreme points are not considered) are removed

If Mode = "EdgesNumber", branches with less that ControlPar edges are removed

If Mode = "EdgesLength", branches with with a length smaller than ControlPar are removed


Albluca/ElPiGraph.R documentation built on June 10, 2018, 5:22 p.m.