Skip to contents

Provides a comprehensive summary of local extrema detection results, including statistics on the number of extrema found, their function values, neighborhood sizes, and radii.

Usage

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

Arguments

object

An object of class "gflow_local_extrema", as returned by detect.adaptive.extrema.

...

Additional arguments (currently ignored).

Value

An object of class "summary.gflow_local_extrema", which is a list containing:

n_extrema

Integer; total number of extrema found

extrema_type

Character; type of extrema ("Maximum" or "Minimum")

fn_values_summary

Named numeric vector; summary statistics of function values at extrema

neighborhood_sizes_summary

Named numeric vector; summary statistics of neighborhood sizes

radius_summary

Named numeric vector; summary statistics of neighborhood radii

extrema_details

Data frame with detailed information about each extremum

Examples

extrema <- list(
  vertices = c(4L, 2L),
  values = c(5, 3),
  radii = c(2, 1),
  neighborhood_sizes = c(3L, 2L),
  is_maxima = c(TRUE, TRUE),
  type = c("Maximum", "Maximum"),
  labels = c("M1", "M2"),
  neighborhood_vertices = list(c(3L, 5L, 2L), c(1L, 3L)),
  detect.maxima = TRUE
)
class(extrema) <- "gflow_local_extrema"

summary(extrema)