OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
grm::Segmenter< TImage, TNode, TParam > Class Template Referenceabstract

#include <grmSegmenter.h>

+ Inheritance diagram for grm::Segmenter< TImage, TNode, TParam >:
+ Collaboration diagram for grm::Segmenter< TImage, TNode, TParam >:

Public Types

typedef IOType::ClusteredImageType ClusteredImageType
 
typedef GraphType::EdgeType EdgeType
 
typedef GraphOperations< Self > GraphOperatorType
 
typedef Graph< NodeType > GraphType
 
typedef TImage ImageType
 
typedef GraphToOtbImage< GraphType > IOType
 
typedef IOType::LabelImageType LabelImageType
 
typedef GraphOperatorType::NodePointerType NodePointerType
 
typedef TNode NodeType
 
typedef TParam ParamType
 
typedef Segmenter< TImage, TNode, TParam > Self
 

Public Member Functions

virtual float ComputeMergingCost (NodePointerType n1, NodePointerType n2)=0
 
ClusteredImageType::Pointer GetClusteredImageOutput ()
 
bool GetComplete ()
 
LabelImageType::Pointer GetLabeledClusteredOutput ()
 
 GRMGetMacro (float, Threshold)
 
 GRMGetMacro (unsigned int, ImageHeight)
 
 GRMGetMacro (unsigned int, ImageWidth)
 
 GRMGetMacro (unsigned int, NumberOfComponentsPerPixel)
 
 GRMGetMacro (unsigned int, NumberOfIterations)
 
 GRMSetMacro (bool, DoFastSegmentation)
 
 GRMSetMacro (float, Threshold)
 
 GRMSetMacro (ParamType, Param)
 
 GRMSetMacro (unsigned int, ImageHeight)
 
 GRMSetMacro (unsigned int, ImageWidth)
 
 GRMSetMacro (unsigned int, NumberOfComponentsPerPixel)
 
 GRMSetMacro (unsigned int, NumberOfIterations)
 
virtual void InitFromImage ()=0
 
 Segmenter ()
 
void SetInput (TImage *in)
 
virtual void Update ()
 
virtual void UpdateSpecificAttributes (NodePointerType n1, NodePointerType n2)=0
 
 ~Segmenter ()
 

Public Attributes

GraphType m_Graph
 

Protected Attributes

bool m_Complete
 
bool m_DoFastSegmentation
 
unsigned int m_ImageHeight
 
unsigned int m_ImageWidth
 
TImage * m_InputImage
 
unsigned int m_NumberOfComponentsPerPixel
 
unsigned int m_NumberOfIterations
 
ParamType m_Param
 
float m_Threshold
 

Detailed Description

template<class TImage, class TNode, class TParam>
class grm::Segmenter< TImage, TNode, TParam >

Definition at line 27 of file grmSegmenter.h.

Member Typedef Documentation

◆ ClusteredImageType

template<class TImage , class TNode , class TParam >
typedef IOType::ClusteredImageType grm::Segmenter< TImage, TNode, TParam >::ClusteredImageType

Definition at line 43 of file grmSegmenter.h.

◆ EdgeType

template<class TImage , class TNode , class TParam >
typedef GraphType::EdgeType grm::Segmenter< TImage, TNode, TParam >::EdgeType

Definition at line 38 of file grmSegmenter.h.

◆ GraphOperatorType

template<class TImage , class TNode , class TParam >
typedef GraphOperations<Self> grm::Segmenter< TImage, TNode, TParam >::GraphOperatorType

Definition at line 39 of file grmSegmenter.h.

◆ GraphType

template<class TImage , class TNode , class TParam >
typedef Graph<NodeType> grm::Segmenter< TImage, TNode, TParam >::GraphType

Definition at line 37 of file grmSegmenter.h.

◆ ImageType

template<class TImage , class TNode , class TParam >
typedef TImage grm::Segmenter< TImage, TNode, TParam >::ImageType

Definition at line 34 of file grmSegmenter.h.

◆ IOType

template<class TImage , class TNode , class TParam >
typedef GraphToOtbImage<GraphType> grm::Segmenter< TImage, TNode, TParam >::IOType

Definition at line 41 of file grmSegmenter.h.

◆ LabelImageType

template<class TImage , class TNode , class TParam >
typedef IOType::LabelImageType grm::Segmenter< TImage, TNode, TParam >::LabelImageType

Definition at line 42 of file grmSegmenter.h.

◆ NodePointerType

template<class TImage , class TNode , class TParam >
typedef GraphOperatorType::NodePointerType grm::Segmenter< TImage, TNode, TParam >::NodePointerType

Definition at line 40 of file grmSegmenter.h.

◆ NodeType

template<class TImage , class TNode , class TParam >
typedef TNode grm::Segmenter< TImage, TNode, TParam >::NodeType

Definition at line 35 of file grmSegmenter.h.

◆ ParamType

template<class TImage , class TNode , class TParam >
typedef TParam grm::Segmenter< TImage, TNode, TParam >::ParamType

Definition at line 36 of file grmSegmenter.h.

◆ Self

template<class TImage , class TNode , class TParam >
typedef Segmenter<TImage, TNode, TParam> grm::Segmenter< TImage, TNode, TParam >::Self

Definition at line 33 of file grmSegmenter.h.

Constructor & Destructor Documentation

◆ Segmenter()

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::Segmenter ( )
inline

Definition at line 47 of file grmSegmenter.h.

◆ ~Segmenter()

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::~Segmenter ( )
inline

Definition at line 52 of file grmSegmenter.h.

Member Function Documentation

◆ ComputeMergingCost()

template<class TImage , class TNode , class TParam >
virtual float grm::Segmenter< TImage, TNode, TParam >::ComputeMergingCost ( NodePointerType  n1,
NodePointerType  n2 
)
pure virtual

Implemented in grm::BaatzSegmenter< TImage >, and grm::SpringSegmenter< TImage >.

◆ GetClusteredImageOutput()

template<class TImage , class TNode , class TParam >
ClusteredImageType::Pointer grm::Segmenter< TImage, TNode, TParam >::GetClusteredImageOutput ( )
inline

Definition at line 117 of file grmSegmenter.h.

◆ GetComplete()

template<class TImage , class TNode , class TParam >
bool grm::Segmenter< TImage, TNode, TParam >::GetComplete ( )
inline

Definition at line 133 of file grmSegmenter.h.

◆ GetLabeledClusteredOutput()

template<class TImage , class TNode , class TParam >
LabelImageType::Pointer grm::Segmenter< TImage, TNode, TParam >::GetLabeledClusteredOutput ( )
inline

Definition at line 110 of file grmSegmenter.h.

◆ GRMGetMacro() [1/5]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMGetMacro ( float  ,
Threshold   
)

◆ GRMGetMacro() [2/5]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMGetMacro ( unsigned int  ,
ImageHeight   
)

◆ GRMGetMacro() [3/5]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMGetMacro ( unsigned int  ,
ImageWidth   
)

◆ GRMGetMacro() [4/5]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMGetMacro ( unsigned int  ,
NumberOfComponentsPerPixel   
)

◆ GRMGetMacro() [5/5]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMGetMacro ( unsigned int  ,
NumberOfIterations   
)

◆ GRMSetMacro() [1/7]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMSetMacro ( bool  ,
DoFastSegmentation   
)

◆ GRMSetMacro() [2/7]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMSetMacro ( float  ,
Threshold   
)

◆ GRMSetMacro() [3/7]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMSetMacro ( ParamType  ,
Param   
)

◆ GRMSetMacro() [4/7]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMSetMacro ( unsigned int  ,
ImageHeight   
)

◆ GRMSetMacro() [5/7]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMSetMacro ( unsigned int  ,
ImageWidth   
)

◆ GRMSetMacro() [6/7]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMSetMacro ( unsigned int  ,
NumberOfComponentsPerPixel   
)

◆ GRMSetMacro() [7/7]

template<class TImage , class TNode , class TParam >
grm::Segmenter< TImage, TNode, TParam >::GRMSetMacro ( unsigned int  ,
NumberOfIterations   
)

◆ InitFromImage()

template<class TImage , class TNode , class TParam >
virtual void grm::Segmenter< TImage, TNode, TParam >::InitFromImage ( )
pure virtual

Implemented in grm::BaatzSegmenter< TImage >, grm::FullLambdaScheduleSegmenter< TImage >, and grm::SpringSegmenter< TImage >.

◆ SetInput()

template<class TImage , class TNode , class TParam >
void grm::Segmenter< TImage, TNode, TParam >::SetInput ( TImage *  in)
inline

Definition at line 132 of file grmSegmenter.h.

◆ Update()

template<class TImage , class TNode , class TParam >
virtual void grm::Segmenter< TImage, TNode, TParam >::Update ( )
inlinevirtual

Definition at line 57 of file grmSegmenter.h.

◆ UpdateSpecificAttributes()

template<class TImage , class TNode , class TParam >
virtual void grm::Segmenter< TImage, TNode, TParam >::UpdateSpecificAttributes ( NodePointerType  n1,
NodePointerType  n2 
)
pure virtual

Implemented in grm::BaatzSegmenter< TImage >, and grm::SpringSegmenter< TImage >.

Member Data Documentation

◆ m_Complete

template<class TImage , class TNode , class TParam >
bool grm::Segmenter< TImage, TNode, TParam >::m_Complete
protected

Definition at line 149 of file grmSegmenter.h.

Referenced by grm::Segmenter< TImage, BaatzNode, BaatzParam >::GetComplete(), grm::Segmenter< TImage, BaatzNode, BaatzParam >::Segmenter(), and grm::Segmenter< TImage, BaatzNode, BaatzParam >::Update().

◆ m_DoFastSegmentation

template<class TImage , class TNode , class TParam >
bool grm::Segmenter< TImage, TNode, TParam >::m_DoFastSegmentation
protected

Definition at line 152 of file grmSegmenter.h.

Referenced by grm::Segmenter< TImage, BaatzNode, BaatzParam >::Segmenter(), and grm::Segmenter< TImage, BaatzNode, BaatzParam >::Update().

◆ m_Graph

template<class TImage , class TNode , class TParam >
GraphType grm::Segmenter< TImage, TNode, TParam >::m_Graph

Definition at line 143 of file grmSegmenter.h.

Referenced by grm::Segmenter< TImage, BaatzNode, BaatzParam >::GetClusteredImageOutput(), and grm::Segmenter< TImage, BaatzNode, BaatzParam >::GetLabeledClusteredOutput().

◆ m_ImageHeight

template<class TImage , class TNode , class TParam >
unsigned int grm::Segmenter< TImage, TNode, TParam >::m_ImageHeight
protected

Definition at line 165 of file grmSegmenter.h.

Referenced by grm::Segmenter< TImage, BaatzNode, BaatzParam >::GetClusteredImageOutput(), and grm::Segmenter< TImage, BaatzNode, BaatzParam >::GetLabeledClusteredOutput().

◆ m_ImageWidth

template<class TImage , class TNode , class TParam >
unsigned int grm::Segmenter< TImage, TNode, TParam >::m_ImageWidth
protected

Definition at line 164 of file grmSegmenter.h.

Referenced by grm::Segmenter< TImage, BaatzNode, BaatzParam >::GetClusteredImageOutput(), and grm::Segmenter< TImage, BaatzNode, BaatzParam >::GetLabeledClusteredOutput().

◆ m_InputImage

template<class TImage , class TNode , class TParam >
TImage* grm::Segmenter< TImage, TNode, TParam >::m_InputImage
protected

Definition at line 169 of file grmSegmenter.h.

Referenced by grm::Segmenter< TImage, BaatzNode, BaatzParam >::SetInput(), and grm::Segmenter< TImage, BaatzNode, BaatzParam >::Update().

◆ m_NumberOfComponentsPerPixel

template<class TImage , class TNode , class TParam >
unsigned int grm::Segmenter< TImage, TNode, TParam >::m_NumberOfComponentsPerPixel
protected

Definition at line 166 of file grmSegmenter.h.

◆ m_NumberOfIterations

template<class TImage , class TNode , class TParam >
unsigned int grm::Segmenter< TImage, TNode, TParam >::m_NumberOfIterations
protected

Definition at line 155 of file grmSegmenter.h.

Referenced by grm::Segmenter< TImage, BaatzNode, BaatzParam >::Segmenter().

◆ m_Param

template<class TImage , class TNode , class TParam >
ParamType grm::Segmenter< TImage, TNode, TParam >::m_Param
protected

Definition at line 161 of file grmSegmenter.h.

◆ m_Threshold

template<class TImage , class TNode , class TParam >
float grm::Segmenter< TImage, TNode, TParam >::m_Threshold
protected

Definition at line 158 of file grmSegmenter.h.

The documentation for this class was generated from the following file:
Generated at Wed Feb 28 2024 15:24:52 for OTB with   doxygen 1.8.17