MorphologicalAttributeFilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
mmcfilters::ExtinctionSelectionPolicy< Real > Class Template Reference

Explicit extinction-extrema selection policy. More...

#include <ExtinctionValues.hpp>

Public Member Functions

bool selectsTopK () const noexcept
 Returns true when the policy selects the first ranked extrema.
 
int extremaToKeep () const noexcept
 Maximum number of ranked extrema retained by a top-k policy.
 
Real minimumExtinction () const noexcept
 Minimum accepted extinction value for a threshold policy.
 

Static Public Member Functions

static ExtinctionSelectionPolicy byTopK (int extremaToKeep) noexcept
 Select the strongest extrema by decreasing extinction ranking.
 
static ExtinctionSelectionPolicy byThreshold (Real threshold) noexcept
 Select every extremum whose extinction value is at least threshold.
 

Detailed Description

template<std::floating_point Real = float>
class mmcfilters::ExtinctionSelectionPolicy< Real >

Explicit extinction-extrema selection policy.

The same policy object is consumed by image reconstruction (filtering) and by contour visualization (contourMap). It only controls which regional extrema are retained; output-specific scoring is configured separately.

Definition at line 61 of file ExtinctionValues.hpp.

Member Function Documentation

◆ byThreshold()

template<std::floating_point Real = float>
static ExtinctionSelectionPolicy mmcfilters::ExtinctionSelectionPolicy< Real >::byThreshold ( Real  threshold)
inlinestaticnoexcept

Select every extremum whose extinction value is at least threshold.

Parameters
thresholdMinimum extinction value retained. Validation is deferred to the operation that consumes the policy.
Returns
Selection policy configured for threshold extinction filtering.

Definition at line 94 of file ExtinctionValues.hpp.

◆ byTopK()

template<std::floating_point Real = float>
static ExtinctionSelectionPolicy mmcfilters::ExtinctionSelectionPolicy< Real >::byTopK ( int  extremaToKeep)
inlinestaticnoexcept

Select the strongest extrema by decreasing extinction ranking.

Parameters
extremaToKeepMaximum number of regional extrema retained. Validation is deferred to the operation that consumes the policy.
Returns
Selection policy configured for top-k extinction filtering.

Definition at line 80 of file ExtinctionValues.hpp.

◆ extremaToKeep()

template<std::floating_point Real = float>
int mmcfilters::ExtinctionSelectionPolicy< Real >::extremaToKeep ( ) const
inlinenoexcept

Maximum number of ranked extrema retained by a top-k policy.

Returns
Stored top-k count. The value is meaningful only when selectsTopK() returns true.

Definition at line 114 of file ExtinctionValues.hpp.

◆ minimumExtinction()

template<std::floating_point Real = float>
Real mmcfilters::ExtinctionSelectionPolicy< Real >::minimumExtinction ( ) const
inlinenoexcept

Minimum accepted extinction value for a threshold policy.

Returns
Stored extinction threshold. The value is meaningful only when selectsTopK() returns false.

Definition at line 122 of file ExtinctionValues.hpp.

◆ selectsTopK()

template<std::floating_point Real = float>
bool mmcfilters::ExtinctionSelectionPolicy< Real >::selectsTopK ( ) const
inlinenoexcept

Returns true when the policy selects the first ranked extrema.

Returns
True for top-k policies; false for threshold policies.

Definition at line 106 of file ExtinctionValues.hpp.


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