mmcfilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mmcfilters::local_attributes::ConnectedSubsetTreeLocalizer Class Reference

Validated public view of connected-subset-tree localization. More...

#include <ConnectedSubsetTreeLocalizer.hpp>

Public Member Functions

 ConnectedSubsetTreeLocalizer (const MorphologicalTree &tree)
 Captures one established tree without building another index.
 
NodeId smallestNode (PixelId pixel) const
 Returns the smallest node of one valid pixel.
 
NodeId join (NodeId lhsSmallestNode, NodeId rhsSmallestNode) const
 Returns the inclusion join, equivalently the LCA, of two live smallest nodes.
 
std::optional< NodeIdanchoredEntry (PixelId anchorPixel, PixelId samplePixel) const
 Returns the first node on the anchor branch containing an absolute sample.
 
std::optional< NodeIdanchoredEntry (PixelId anchorPixel, WindowOffset offset) const
 Returns the first node containing a translated sample.
 

Detailed Description

Validated public view of connected-subset-tree localization.

The hot finite-window kernels use the equivalent functions in detail::kernel after validating once at their public boundary. This view is intended for explicit theorem-facing queries and therefore validates pixels, nodes, the grid domain, and captured-tree stability per call.

Definition at line 69 of file ConnectedSubsetTreeLocalizer.hpp.

Constructor & Destructor Documentation

◆ ConnectedSubsetTreeLocalizer()

mmcfilters::local_attributes::ConnectedSubsetTreeLocalizer::ConnectedSubsetTreeLocalizer ( const MorphologicalTree tree)
inlineexplicit

Captures one established tree without building another index.

Parameters
treeStable connected-subset tree.

Definition at line 72 of file ConnectedSubsetTreeLocalizer.hpp.

Member Function Documentation

◆ anchoredEntry() [1/2]

std::optional< NodeId > mmcfilters::local_attributes::ConnectedSubsetTreeLocalizer::anchoredEntry ( PixelId  anchorPixel,
PixelId  samplePixel 
) const
inline

Returns the first node on the anchor branch containing an absolute sample.

Parameters
anchorPixelValid anchor pixel.
samplePixelValid translated-sample pixel.
Returns
Anchored entry, or no value for an invalid pixel.

Definition at line 109 of file ConnectedSubsetTreeLocalizer.hpp.

◆ anchoredEntry() [2/2]

std::optional< NodeId > mmcfilters::local_attributes::ConnectedSubsetTreeLocalizer::anchoredEntry ( PixelId  anchorPixel,
WindowOffset  offset 
) const
inline

Returns the first node containing a translated sample.

Parameters
anchorPixelValid anchor pixel.
offsetRelative row-column sample offset.
Returns
Anchored entry, or no value outside the grid.

Definition at line 123 of file ConnectedSubsetTreeLocalizer.hpp.

◆ join()

NodeId mmcfilters::local_attributes::ConnectedSubsetTreeLocalizer::join ( NodeId  lhsSmallestNode,
NodeId  rhsSmallestNode 
) const
inline

Returns the inclusion join, equivalently the LCA, of two live smallest nodes.

Parameters
lhsSmallestNodeFirst live node.
rhsSmallestNodeSecond live node.
Returns
Lowest common ancestor.

Definition at line 95 of file ConnectedSubsetTreeLocalizer.hpp.

◆ smallestNode()

NodeId mmcfilters::local_attributes::ConnectedSubsetTreeLocalizer::smallestNode ( PixelId  pixel) const
inline

Returns the smallest node of one valid pixel.

Parameters
pixelValid pixel.
Returns
Pixel's smallest node.

Definition at line 77 of file ConnectedSubsetTreeLocalizer.hpp.


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