lhs.dr.add: Define directional routes

Description Usage Arguments Value Note

Description

Defines 'directional routes' by identifying parent points that are 1) temporally contiguous and 2) have hulls in the top n

Usage

1
2
3
lhs.dr.add(lhs, metric = c("ecc", "par")[2], thresh.val = 0.95,
  thresh.type = c("q", "v")[1], smooth = 1, status = TRUE,
  show.elong.hist = FALSE)

Arguments

lhs

A LoCoH-hullset object

metric

The name of the hull metric used as a proxy for directionality

thresh.val

The threshhold above which a hull is considered part of a directional route

thresh.type

The type of thresshold used. If 'q' for quantile, then thresh.val is taken to be a percentile of the full range of the directionality metric values (i.e., 0 < thresh.val < 1). If 'v', thresh.val is taken to be an actual value of the threshhold metric.

smooth

The amount of temporal smoothing applied, expressed as the number of points on either side (temporally) of the parent point whose average of the directionality metric is used for determining if the hull constructed around the parent point should be considered a part of a directional route. For no smoothing, set smooth = 0.

status

Display status messages

show.elong.hist

Whether to display histogram(s) of the distribution of the directionality metric before and after smoothing. T/F

Value

A LoCoH-hullset object

Note

Directional routes are line segments defined by connecting temporally contiguous hull parent-points that are in the top N percent of hull elongation. Hull elongation is proxied by one of two hull metrics: perimeter:area ratio ('par') or the eccentricity of the bounding ellipse ('ecc'). Hull perimeter:area ratios are automatically computed when a hullset is created; bounding ellipses must be computed separately using lhs.ellipses.add. Once computed, you can plot directional routes by passing dr=TRUE to plot.locoh.lhs.


tlocoh documentation built on May 2, 2019, 5:27 p.m.