mmcfilters::sdrt::SaturatedResidualTreeBuilder< T > Class Template Reference

Builds the saturated residual tree from synchronized component trees. More...

#include <SaturatedResidualTreeBuilder.hpp>

Public Types
using	Altitude = T
	Residual-node altitude type.
using	ImagePointer = ImagePtr< Altitude >
	Shared input image type.
using	Tree = ValuedMorphologicalTree< Altitude >
	Component-tree seed type.

Public Member Functions
	SaturatedResidualTreeBuilder (RegularGridAdjacency2D adjacency, PixelId infinityPixel, SaturatedResidualTreeOptions options={})
	Creates a reusable saturated builder from an extensible option object.
void	build (const ImagePointer &image, Tree &&minTree, Tree &&maxTree)
	Consumes synchronized min-tree and max-tree seeds.
int	rows () const
int	columns () const
NodeId	root () const
PixelId	infinityPixel () const noexcept
const RegularGridAdjacency2D &	adjacency () const noexcept
const SpatialOrder &	spatialOrder () const noexcept
SaturatedMinMaxLcaPolicy	lcaPolicy () const noexcept
SaturatedMinMaxFallbackPolicy	fallbackPolicy () const noexcept
std::span< const NodeId >	parents () const
std::span< const NodeId >	smallestNodeMap () const
std::span< const Altitude >	nodeAltitudes () const
const ResidualTreeBuildStatistics &	statistics () const
mmcfilters::detail::ValidatedNativeHierarchy< Altitude >	takeValidatedHierarchy (MorphologicalTreeSemantics semantics) &&
	Transfers the completed result into validated native storage.

Detailed Description

template<AltitudeValue T>
class mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >

Builds the saturated residual tree from synchronized component trees.

A current regional extremum is eligible only when its complement is connected relative to the configured infinity pixel. This API owns every policy that participates in that certification.

Template Parameters

T	Finite image and residual-node altitude type.

Definition at line 26 of file SaturatedResidualTreeBuilder.hpp.

Member Typedef Documentation

Altitude

template<AltitudeValue T>

using mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::Altitude = T

Residual-node altitude type.

Definition at line 28 of file SaturatedResidualTreeBuilder.hpp.

ImagePointer

template<AltitudeValue T>

using mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::ImagePointer = ImagePtr<Altitude>

Shared input image type.

Definition at line 29 of file SaturatedResidualTreeBuilder.hpp.

Tree

template<AltitudeValue T>

using mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::Tree = ValuedMorphologicalTree<Altitude>

Component-tree seed type.

Definition at line 30 of file SaturatedResidualTreeBuilder.hpp.

Constructor & Destructor Documentation

SaturatedResidualTreeBuilder()

template<AltitudeValue T>

mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::SaturatedResidualTreeBuilder ( RegularGridAdjacency2D  adjacency, PixelId  infinityPixel, SaturatedResidualTreeOptions  options = {}  )

inlineexplicit

Creates a reusable saturated builder from an extensible option object.

Parameters

adjacency	Symmetric connected adjacency shared by both seeds.
infinityPixel	Row-major infinity pixel.
options	Saturation and ordering policies.

Definition at line 38 of file SaturatedResidualTreeBuilder.hpp.

Member Function Documentation

adjacency()

template<AltitudeValue T>

const RegularGridAdjacency2D & mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::adjacency ( ) const

inlinenoexcept

Returns

Configured grid adjacency.

Definition at line 61 of file SaturatedResidualTreeBuilder.hpp.

build()

template<AltitudeValue T>

void mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::build ( const ImagePointer &  image, Tree &&  minTree, Tree &&  maxTree  )

inline

Consumes synchronized min-tree and max-tree seeds.

Parameters

image	Image reconstructed by the resulting residual hierarchy.
minTree	Min-tree seed consumed by the construction.
maxTree	Max-tree seed consumed by the construction.

Definition at line 48 of file SaturatedResidualTreeBuilder.hpp.

columns()

template<AltitudeValue T>

int mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::columns ( ) const

inline

Returns

Number of columns in the last completed build.

Definition at line 55 of file SaturatedResidualTreeBuilder.hpp.

fallbackPolicy()

template<AltitudeValue T>

SaturatedMinMaxFallbackPolicy mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::fallbackPolicy ( ) const

inlinenoexcept

Returns

Configured exact complement fallback.

Definition at line 67 of file SaturatedResidualTreeBuilder.hpp.

infinityPixel()

template<AltitudeValue T>

PixelId mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::infinityPixel ( ) const

inlinenoexcept

Returns

Declared row-major infinity pixel.

Definition at line 59 of file SaturatedResidualTreeBuilder.hpp.

lcaPolicy()

template<AltitudeValue T>

SaturatedMinMaxLcaPolicy mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::lcaPolicy ( ) const

inlinenoexcept

Returns

Configured dynamic LCA policy.

Definition at line 65 of file SaturatedResidualTreeBuilder.hpp.

nodeAltitudes()

template<AltitudeValue T>

std::span< const Altitude > mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::nodeAltitudes ( ) const

inline

Returns

Altitude buffer indexed by residual node id.

Definition at line 73 of file SaturatedResidualTreeBuilder.hpp.

parents()

template<AltitudeValue T>

std::span< const NodeId > mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::parents ( ) const

inline

Returns

Parent buffer indexed by residual node id.

Definition at line 69 of file SaturatedResidualTreeBuilder.hpp.

root()

template<AltitudeValue T>

NodeId mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::root ( ) const

inline

Returns

Dense root node identifier.

Definition at line 57 of file SaturatedResidualTreeBuilder.hpp.

rows()

template<AltitudeValue T>

int mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::rows ( ) const

inline

Returns

Number of rows in the last completed build.

Definition at line 53 of file SaturatedResidualTreeBuilder.hpp.

smallestNodeMap()

template<AltitudeValue T>

std::span< const NodeId > mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::smallestNodeMap ( ) const

inline

Returns

Smallest residual node indexed by source pixel id.

Definition at line 71 of file SaturatedResidualTreeBuilder.hpp.

spatialOrder()

template<AltitudeValue T>

const SpatialOrder & mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::spatialOrder ( ) const

inlinenoexcept

Returns

Total order used to define support minima.

Definition at line 63 of file SaturatedResidualTreeBuilder.hpp.

statistics()

template<AltitudeValue T>

const ResidualTreeBuildStatistics & mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::statistics ( ) const

inline

Returns

Correctness-oriented statistics from the last completed build.

Definition at line 75 of file SaturatedResidualTreeBuilder.hpp.

takeValidatedHierarchy()

template<AltitudeValue T>

mmcfilters::detail::ValidatedNativeHierarchy< Altitude > mmcfilters::sdrt::SaturatedResidualTreeBuilder< T >::takeValidatedHierarchy ( MorphologicalTreeSemantics  semantics ) &&

inline

Transfers the completed result into validated native storage.

Parameters

semantics

Semantic descriptor assigned to the transferred hierarchy.

Returns

Validated native buffers and their topology proof.

Definition at line 82 of file SaturatedResidualTreeBuilder.hpp.

---

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

• mmcfilters/trees/sdrt/SaturatedResidualTreeBuilder.hpp