MorphologicalTreeSemantics.hpp File Reference

Immutable scientific metadata attached to a morphological tree. More...

#include "../utils/Common.hpp"
#include "../utils/RegularGridAdjacency2D.hpp"
#include <utility>
#include <stdexcept>
#include <variant>

Include dependency graph for MorphologicalTreeSemantics.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	mmcfilters::NoConstructionContext
	Explicitly records that no construction context is available. More...
struct	mmcfilters::SharedAdjacencyContext
	Records one adjacency shared by both construction polarities. More...
struct	mmcfilters::SaturatedResidualContext
	Records the shared adjacency and infinity pixel of a saturated residual construction. More...
struct	mmcfilters::ComplementaryAdjacencies
	Ordered pair of complementary minimum and maximum adjacencies. More...
struct	mmcfilters::SelfDualSpanImmersion
	Selects the self-dual span-valued tree-of-shapes immersion. More...
struct	mmcfilters::ComplementaryGridImmersion
	Selects the optimized complementary-grid immersion. More...
struct	mmcfilters::TopographicConvention
	Complete discrete convention retained by a tree-of-shapes result. More...
struct	mmcfilters::MorphologicalTreeSemantics
	Immutable scientific interpretation attached to one morphological tree. More...

Typedefs
using	mmcfilters::TreeOfShapesImmersion = std::variant< SelfDualSpanImmersion, ComplementaryGridImmersion >
	Tagged tree-of-shapes immersion family.
using	mmcfilters::MorphologicalTreeConstructionContext = std::variant< NoConstructionContext, SharedAdjacencyContext, SaturatedResidualContext, TopographicConvention >
	Tagged construction context retained by morphological-tree semantics.

Enumerations
enum class	mmcfilters::MorphologicalTreeKind {   Generic , MaxTree , MinTree , TreeOfShapes ,   UnrestrictedResidualTree , SaturatedResidualTree }
	Declared construction family of one morphological tree. More...
enum class	mmcfilters::NodeAltitudeOrder { Increasing , Decreasing , Unconstrained }
	Global ordering constraint of node altitudes along parent-child arcs. More...
enum class	mmcfilters::TopographicDomainExtension { ExteriorRing , None }
	Relation between the source pixel domain and active topographic domain. More...

Functions
NodeAltitudeOrder	mmcfilters::defaultNodeAltitudeOrder (MorphologicalTreeKind kind) noexcept
	Returns the conventional node-altitude order of a declared tree kind.
MorphologicalTreeSemantics	mmcfilters::makeMorphologicalTreeSemantics (MorphologicalTreeKind kind, MorphologicalTreeConstructionContext constructionContext=NoConstructionContext{})
	Constructs semantics using the conventional altitude order of kind.
void	mmcfilters::validateMorphologicalTreeSemantics (const MorphologicalTreeSemantics &semantics)
	Validates the scientific compatibility of a semantics descriptor.

Detailed Description

Immutable scientific metadata attached to a morphological tree.

Definition in file MorphologicalTreeSemantics.hpp.

Typedef Documentation

MorphologicalTreeConstructionContext

using mmcfilters::MorphologicalTreeConstructionContext = typedef std::variant<NoConstructionContext, SharedAdjacencyContext, SaturatedResidualContext, TopographicConvention>

Tagged construction context retained by morphological-tree semantics.

Definition at line 79 of file MorphologicalTreeSemantics.hpp.

TreeOfShapesImmersion

using mmcfilters::TreeOfShapesImmersion = typedef std::variant<SelfDualSpanImmersion, ComplementaryGridImmersion>

Tagged tree-of-shapes immersion family.

Definition at line 66 of file MorphologicalTreeSemantics.hpp.

Enumeration Type Documentation

MorphologicalTreeKind

enum class mmcfilters::MorphologicalTreeKind

strong

Declared construction family of one morphological tree.

Definition at line 18 of file MorphologicalTreeSemantics.hpp.

NodeAltitudeOrder

enum class mmcfilters::NodeAltitudeOrder

strong

Global ordering constraint of node altitudes along parent-child arcs.

Enumerator
Increasing	Every alive parent-child arc satisfies nodeAltitude(parent) < nodeAltitude(child).
Decreasing	Every alive parent-child arc satisfies nodeAltitude(parent) > nodeAltitude(child).
Unconstrained	No global parent-child altitude order is declared.

Definition at line 28 of file MorphologicalTreeSemantics.hpp.

TopographicDomainExtension

enum class mmcfilters::TopographicDomainExtension

strong

Relation between the source pixel domain and active topographic domain.

Definition at line 69 of file MorphologicalTreeSemantics.hpp.

Function Documentation

defaultNodeAltitudeOrder()

NodeAltitudeOrder mmcfilters::defaultNodeAltitudeOrder ( MorphologicalTreeKind  kind )

inlinenoexcept

Returns the conventional node-altitude order of a declared tree kind.

Parameters

kind	Declared tree kind.

Returns

Conventional altitude order.

Definition at line 95 of file MorphologicalTreeSemantics.hpp.

makeMorphologicalTreeSemantics()

MorphologicalTreeSemantics mmcfilters::makeMorphologicalTreeSemantics ( MorphologicalTreeKind  kind, MorphologicalTreeConstructionContext  constructionContext = NoConstructionContext{}  )

inline

Constructs semantics using the conventional altitude order of kind.

Parameters

kind	Declared tree kind.
constructionContext	Retained typed context.

Returns

Coherent semantics descriptor.

Definition at line 111 of file MorphologicalTreeSemantics.hpp.

validateMorphologicalTreeSemantics()

void mmcfilters::validateMorphologicalTreeSemantics ( const MorphologicalTreeSemantics &  semantics )

inline

Validates the scientific compatibility of a semantics descriptor.

NoConstructionContext is valid for every kind because it explicitly records unavailable provenance. Every concrete context is restricted to the construction families whose parameters it represents.

Parameters

semantics

Descriptor to validate.

Definition at line 125 of file MorphologicalTreeSemantics.hpp.