Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
Public Member Functions | List of all members
AMSContourExtractor Class Reference

Extracts iso-contours using an adaptive marching-squares backend. More...

#include <AMSContourExtractor.h>

Inheritance diagram for AMSContourExtractor:
Inheritance graph
[legend]
Collaboration diagram for AMSContourExtractor:
Collaboration graph
[legend]

Public Member Functions

 AMSContourExtractor (ContourProgressCallback on_progress={})
 Constructs an AMS contour extractor.
 
Contour extract (const ScalarField2D &field, const ContourRequest &cr) override
 Extracts contour paths from a scalar field.
 
- Public Member Functions inherited from IContourExtractor
virtual ~IContourExtractor ()=default
 

Detailed Description

Extracts iso-contours using an adaptive marching-squares backend.

The extractor converts a requested grid resolution into a marching-squares recursion depth, evaluates the provided scalar field, and returns every path found at the requested contour level.

Progress reporting is optional. When a callback is provided, the extractor emits ContourProgressEventType::PathPoint events for every contour point and ContourProgressEventType::PathFinished events after each path.

Note
The implementation caps the internal recursion depth to keep extraction cost bounded and reports failure by returning a contour with success == false rather than throwing for recoverable extraction errors.

Definition at line 41 of file AMSContourExtractor.h.

Constructor & Destructor Documentation

◆ AMSContourExtractor()

AMSContourExtractor::AMSContourExtractor ( ContourProgressCallback  on_progress = {})
inlineexplicit

Constructs an AMS contour extractor.

Parameters
on_progressOptional callback invoked while contour paths are emitted. Pass an empty callback to disable progress reporting.

Definition at line 49 of file AMSContourExtractor.h.

Member Function Documentation

◆ extract()

Contour AMSContourExtractor::extract ( const ScalarField2D &  field,
const ContourRequest &  cr 
)
overridevirtual

Extracts contour paths from a scalar field.

Parameters
fieldScalar function evaluated as $f(x,y)$.
crContour extraction request.
Returns
Extracted contour object, including paths and success flag.
Exceptions
std::exceptionif the concrete extraction algorithm encounters a non-recoverable error.
Returns
A contour whose Contour::success flag is true only when at least one path was found.

Implements IContourExtractor.

Definition at line 7 of file AMSContourExtractor.cpp.

The documentation for this class was generated from the following files: