OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
otb::MRFSampler< TInput1, TInput2 > Class Template Referenceabstract

#include <otbMRFSampler.h>

+ Inheritance diagram for otb::MRFSampler< TInput1, TInput2 >:
+ Collaboration diagram for otb::MRFSampler< TInput1, TInput2 >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef EnergyFidelityType::Pointer EnergyFidelityPointer
 
typedef MRFEnergy< TInput1, TInput2 > EnergyFidelityType
 
typedef EnergyRegularizationType::Pointer EnergyRegularizationPointer
 
typedef MRFEnergy< TInput2, TInput2 > EnergyRegularizationType
 
typedef itk::ConstNeighborhoodIterator< TInput1 > InputImageNeighborhoodIterator
 
typedef TInput1::PixelType InputImagePixelType
 
typedef itk::NeighborhoodIterator< TInput2 > LabelledImageNeighborhoodIterator
 
typedef TInput2::PixelType LabelledImagePixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef MRFSampler Self
 
typedef itk::Object Superclass
 

Public Member Functions

virtual int Compute (const InputImageNeighborhoodIterator &itData, const LabelledImageNeighborhoodIterator &itRegul)=0
 
virtual double GetDeltaEnergy ()
 
virtual double GetEnergyAfter () const
 
virtual double GetEnergyBefore () const
 
virtual double GetLambda ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfClasses ()
 
virtual LabelledImagePixelType GetValue ()
 
virtual void SetEnergyFidelity (EnergyFidelityType *_arg)
 
virtual void SetEnergyRegularization (EnergyRegularizationType *_arg)
 
virtual void SetLambda (double _arg)
 
virtual void SetNumberOfClasses (unsigned int _arg)
 

Protected Member Functions

 MRFSampler ()
 
 ~MRFSampler () override
 

Protected Attributes

double m_DeltaEnergy
 
double m_EnergyAfter
 
double m_EnergyBefore
 
double m_EnergyCurrent
 
EnergyFidelityPointer m_EnergyFidelity
 
EnergyRegularizationPointer m_EnergyRegularization
 
double m_Lambda
 
unsigned int m_NumberOfClasses
 
LabelledImagePixelType m_Value
 
LabelledImagePixelType m_ValueCurrent
 

Detailed Description

template<class TInput1, class TInput2>
class otb::MRFSampler< TInput1, TInput2 >

This is the base class for sampler methods used in the MRF framework.

Derived class must reimplement Compute() method.

This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter

Definition at line 44 of file otbMRFSampler.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInput1 , class TInput2 >
typedef itk::SmartPointer<const Self> otb::MRFSampler< TInput1, TInput2 >::ConstPointer

Definition at line 50 of file otbMRFSampler.h.

◆ EnergyFidelityPointer

template<class TInput1 , class TInput2 >
typedef EnergyFidelityType::Pointer otb::MRFSampler< TInput1, TInput2 >::EnergyFidelityPointer

Definition at line 61 of file otbMRFSampler.h.

◆ EnergyFidelityType

template<class TInput1 , class TInput2 >
typedef MRFEnergy<TInput1, TInput2> otb::MRFSampler< TInput1, TInput2 >::EnergyFidelityType

Definition at line 58 of file otbMRFSampler.h.

◆ EnergyRegularizationPointer

template<class TInput1 , class TInput2 >
typedef EnergyRegularizationType::Pointer otb::MRFSampler< TInput1, TInput2 >::EnergyRegularizationPointer

Definition at line 62 of file otbMRFSampler.h.

◆ EnergyRegularizationType

template<class TInput1 , class TInput2 >
typedef MRFEnergy<TInput2, TInput2> otb::MRFSampler< TInput1, TInput2 >::EnergyRegularizationType

Definition at line 59 of file otbMRFSampler.h.

◆ InputImageNeighborhoodIterator

template<class TInput1 , class TInput2 >
typedef itk::ConstNeighborhoodIterator<TInput1> otb::MRFSampler< TInput1, TInput2 >::InputImageNeighborhoodIterator

Definition at line 52 of file otbMRFSampler.h.

◆ InputImagePixelType

template<class TInput1 , class TInput2 >
typedef TInput1::PixelType otb::MRFSampler< TInput1, TInput2 >::InputImagePixelType

Definition at line 53 of file otbMRFSampler.h.

◆ LabelledImageNeighborhoodIterator

template<class TInput1 , class TInput2 >
typedef itk::NeighborhoodIterator<TInput2> otb::MRFSampler< TInput1, TInput2 >::LabelledImageNeighborhoodIterator

Definition at line 55 of file otbMRFSampler.h.

◆ LabelledImagePixelType

template<class TInput1 , class TInput2 >
typedef TInput2::PixelType otb::MRFSampler< TInput1, TInput2 >::LabelledImagePixelType

Definition at line 56 of file otbMRFSampler.h.

◆ Pointer

template<class TInput1 , class TInput2 >
typedef itk::SmartPointer<Self> otb::MRFSampler< TInput1, TInput2 >::Pointer

Definition at line 49 of file otbMRFSampler.h.

◆ Self

template<class TInput1 , class TInput2 >
typedef MRFSampler otb::MRFSampler< TInput1, TInput2 >::Self

Definition at line 47 of file otbMRFSampler.h.

◆ Superclass

template<class TInput1 , class TInput2 >
typedef itk::Object otb::MRFSampler< TInput1, TInput2 >::Superclass

Definition at line 48 of file otbMRFSampler.h.

Constructor & Destructor Documentation

◆ MRFSampler()

template<class TInput1 , class TInput2 >
otb::MRFSampler< TInput1, TInput2 >::MRFSampler ( )
inlineprotected

Definition at line 99 of file otbMRFSampler.h.

◆ ~MRFSampler()

template<class TInput1 , class TInput2 >
otb::MRFSampler< TInput1, TInput2 >::~MRFSampler ( )
inlineoverrideprotected

Definition at line 104 of file otbMRFSampler.h.

Member Function Documentation

◆ Compute()

template<class TInput1 , class TInput2 >
virtual int otb::MRFSampler< TInput1, TInput2 >::Compute ( const InputImageNeighborhoodIterator itData,
const LabelledImageNeighborhoodIterator itRegul 
)
pure virtual

◆ GetDeltaEnergy()

template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetDeltaEnergy ( )
virtual

◆ GetEnergyAfter()

template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetEnergyAfter ( ) const
virtual

◆ GetEnergyBefore()

template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetEnergyBefore ( ) const
virtual

◆ GetLambda()

template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetLambda ( )
virtual

◆ GetNameOfClass()

template<class TInput1 , class TInput2 >
virtual const char* otb::MRFSampler< TInput1, TInput2 >::GetNameOfClass ( ) const
virtual

◆ GetNumberOfClasses()

template<class TInput1 , class TInput2 >
virtual unsigned int otb::MRFSampler< TInput1, TInput2 >::GetNumberOfClasses ( )
virtual

◆ GetValue()

template<class TInput1 , class TInput2 >
virtual LabelledImagePixelType otb::MRFSampler< TInput1, TInput2 >::GetValue ( )
virtual

◆ SetEnergyFidelity()

template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetEnergyFidelity ( EnergyFidelityType _arg)
virtual

◆ SetEnergyRegularization()

template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetEnergyRegularization ( EnergyRegularizationType _arg)
virtual

◆ SetLambda()

template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetLambda ( double  _arg)
virtual

◆ SetNumberOfClasses()

template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetNumberOfClasses ( unsigned int  _arg)
virtual

Member Data Documentation

◆ m_DeltaEnergy

template<class TInput1 , class TInput2 >
double otb::MRFSampler< TInput1, TInput2 >::m_DeltaEnergy
protected

Definition at line 88 of file otbMRFSampler.h.

◆ m_EnergyAfter

template<class TInput1 , class TInput2 >
double otb::MRFSampler< TInput1, TInput2 >::m_EnergyAfter
protected

Definition at line 87 of file otbMRFSampler.h.

◆ m_EnergyBefore

template<class TInput1 , class TInput2 >
double otb::MRFSampler< TInput1, TInput2 >::m_EnergyBefore
protected

Definition at line 86 of file otbMRFSampler.h.

◆ m_EnergyCurrent

template<class TInput1 , class TInput2 >
double otb::MRFSampler< TInput1, TInput2 >::m_EnergyCurrent
protected

Definition at line 89 of file otbMRFSampler.h.

◆ m_EnergyFidelity

template<class TInput1 , class TInput2 >
EnergyFidelityPointer otb::MRFSampler< TInput1, TInput2 >::m_EnergyFidelity
protected

Definition at line 94 of file otbMRFSampler.h.

◆ m_EnergyRegularization

template<class TInput1 , class TInput2 >
EnergyRegularizationPointer otb::MRFSampler< TInput1, TInput2 >::m_EnergyRegularization
protected

Definition at line 93 of file otbMRFSampler.h.

◆ m_Lambda

template<class TInput1 , class TInput2 >
double otb::MRFSampler< TInput1, TInput2 >::m_Lambda
protected

Definition at line 90 of file otbMRFSampler.h.

◆ m_NumberOfClasses

template<class TInput1 , class TInput2 >
unsigned int otb::MRFSampler< TInput1, TInput2 >::m_NumberOfClasses
protected

Definition at line 85 of file otbMRFSampler.h.

◆ m_Value

template<class TInput1 , class TInput2 >
LabelledImagePixelType otb::MRFSampler< TInput1, TInput2 >::m_Value
protected

Definition at line 92 of file otbMRFSampler.h.

◆ m_ValueCurrent

template<class TInput1 , class TInput2 >
LabelledImagePixelType otb::MRFSampler< TInput1, TInput2 >::m_ValueCurrent
protected

Definition at line 95 of file otbMRFSampler.h.


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