Cut a Basin Merge Tree at a Scalar-Field Height — cut.basin.merge.tree • gflow

Computes connected components of the exact graph superlevel set field >= height for maximum trees, or sublevel set field <= height for minimum trees. Equality is included, so a saddle plateau has already joined its incident components at its exact scalar-field level. Every returned component is labeled by the elder basin that survives at the cut.

Usage

# S3 method for class 'basin.merge.tree'
cut(x, height, direction = "max", component = NULL, ...)

Arguments

x: A basin.merge.tree, or a compatible basin_complex.
height: Finite scalar-field cut height.
direction: Tree orientation, "max" or "min".
component: Optional graph-component number. When omitted, all graph components are cut.
...: Reserved for S3 compatibility.

Value

A basin.merge.tree.cut list with component and vertex-membership tables, the number of active vertices and components, and cut metadata.