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

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

#include <UnrestrictedResidualTreeBuilder.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
	UnrestrictedResidualTreeBuilder (RegularGridAdjacency2D adjacency, UnrestrictedResidualTreeOptions options={})
	Creates a reusable unrestricted 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
const RegularGridAdjacency2D &	adjacency () const noexcept
const SpatialOrder &	spatialOrder () 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::UnrestrictedResidualTreeBuilder< T >

Builds the unrestricted residual tree from synchronized component trees.

Every current non-root regional extremum is eligible. Saturation certification, the infinity pixel, and saturation-specific policy choices are deliberately absent from this API.

Template Parameters

T	Finite image and residual-node altitude type.

Definition at line 26 of file UnrestrictedResidualTreeBuilder.hpp.

Member Typedef Documentation

Altitude

template<AltitudeValue T>

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

Residual-node altitude type.

Definition at line 28 of file UnrestrictedResidualTreeBuilder.hpp.

ImagePointer

template<AltitudeValue T>

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

Shared input image type.

Definition at line 29 of file UnrestrictedResidualTreeBuilder.hpp.

Tree

template<AltitudeValue T>

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

Component-tree seed type.

Definition at line 30 of file UnrestrictedResidualTreeBuilder.hpp.

Constructor & Destructor Documentation

UnrestrictedResidualTreeBuilder()

template<AltitudeValue T>

mmcfilters::sdrt::UnrestrictedResidualTreeBuilder< T >::UnrestrictedResidualTreeBuilder ( RegularGridAdjacency2D  adjacency, UnrestrictedResidualTreeOptions  options = {}  )

inlineexplicit

Creates a reusable unrestricted builder from an extensible option object.

Parameters

adjacency	Symmetric connected adjacency shared by both seeds.
options	Ordering policies for unrestricted construction.

Definition at line 37 of file UnrestrictedResidualTreeBuilder.hpp.

Member Function Documentation

adjacency()

template<AltitudeValue T>

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

inlinenoexcept

Returns

Configured grid adjacency.

Definition at line 57 of file UnrestrictedResidualTreeBuilder.hpp.

build()

template<AltitudeValue T>

void mmcfilters::sdrt::UnrestrictedResidualTreeBuilder< 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 46 of file UnrestrictedResidualTreeBuilder.hpp.

columns()

template<AltitudeValue T>

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

inline

Returns

Number of columns in the last completed build.

Definition at line 53 of file UnrestrictedResidualTreeBuilder.hpp.

nodeAltitudes()

template<AltitudeValue T>

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

inline

Returns

Altitude buffer indexed by residual node id.

Definition at line 65 of file UnrestrictedResidualTreeBuilder.hpp.

parents()

template<AltitudeValue T>

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

inline

Returns

Parent buffer indexed by residual node id.

Definition at line 61 of file UnrestrictedResidualTreeBuilder.hpp.

root()

template<AltitudeValue T>

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

inline

Returns

Dense root node identifier.

Definition at line 55 of file UnrestrictedResidualTreeBuilder.hpp.

rows()

template<AltitudeValue T>

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

inline

Returns

Number of rows in the last completed build.

Definition at line 51 of file UnrestrictedResidualTreeBuilder.hpp.

smallestNodeMap()

template<AltitudeValue T>

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

inline

Returns

Smallest residual node indexed by source pixel id.

Definition at line 63 of file UnrestrictedResidualTreeBuilder.hpp.

spatialOrder()

template<AltitudeValue T>

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

inlinenoexcept

Returns

Total order used to define support minima.

Definition at line 59 of file UnrestrictedResidualTreeBuilder.hpp.

statistics()

template<AltitudeValue T>

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

inline

Returns

Correctness-oriented statistics from the last completed build.

Definition at line 67 of file UnrestrictedResidualTreeBuilder.hpp.

takeValidatedHierarchy()

template<AltitudeValue T>

mmcfilters::detail::ValidatedNativeHierarchy< Altitude > mmcfilters::sdrt::UnrestrictedResidualTreeBuilder< 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 74 of file UnrestrictedResidualTreeBuilder.hpp.

---

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

• mmcfilters/trees/sdrt/UnrestrictedResidualTreeBuilder.hpp