Summarize Gradient-Flow Basin Results

Usage

# S3 method for class 'gflow_basins'
summary(object, ...)

Arguments

object: An object of class "gflow_basins"
...: Additional arguments (currently ignored)

Value

An object of class "summary.gflow_basins" containing:

n_extrema: Total number of extrema detected
n_minima: Number of local minima
n_maxima: Number of local maxima
n_ascending_basins: Number of ascending basins
n_descending_basins: Number of descending basins
ascending_basin_sizes: Summary statistics for ascending basin sizes
descending_basin_sizes: Summary statistics for descending basin sizes

Examples

basins <- list(
  basins = list(
    ascending = list(
      list(basin = cbind(vertex = c(1L, 2L, 3L))),
      list(basin = cbind(vertex = c(4L, 5L)))
    ),
    descending = list(
      list(basin = cbind(vertex = c(2L, 3L, 4L, 5L)))
    )
  ),
  local_extrema = data.frame(
    vertex_index = c(2L, 5L, 4L),
    is_maximum = c(0L, 0L, 1L),
    label = c("m1", "m2", "M1")
  )
)
class(basins) <- "gflow_basins"

summary(basins)