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

#include <otbMRFEnergy.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef TInput1 InputImageType
 
typedef itk::ConstNeighborhoodIterator< InputImageTypeInputNeighborhoodIterator
 
typedef LabelledImageType::PixelType LabelledImagePixelType
 
typedef TInput2 LabelledImageType
 
typedef itk::ConstNeighborhoodIterator< LabelledImageTypeLabelledNeighborhoodIterator
 
typedef itk::Array< double > ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef MRFEnergy Self
 
typedef itk::Object Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfParameters () const
 
const ParametersTypeGetParameters (void) const
 
virtual double GetSingleValue (const InputImagePixelType &, const LabelledImagePixelType &)
 
virtual double GetValue (const InputImagePixelType &value1, const LabelledImagePixelType &value2)
 
virtual double GetValue (const InputNeighborhoodIterator &it, const LabelledImagePixelType &value2)
 
virtual double GetValue (const LabelledNeighborhoodIterator &it, const LabelledImagePixelType &value2)
 
virtual void SetNumberOfParameters (unsigned int _arg)
 
void SetParameters (const ParametersType &parameters)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 MRFEnergy ()
 
 ~MRFEnergy () override
 

Protected Attributes

unsigned int m_NumberOfParameters
 
ParametersType m_Parameters
 

Detailed Description

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

This is the base class for energy function used in the MRF framework.

Derived class must reimplement the GetSingleValue() method.

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

Definition at line 43 of file otbMRFEnergy.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 49 of file otbMRFEnergy.h.

◆ InputImagePixelType

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

Definition at line 53 of file otbMRFEnergy.h.

◆ InputImageType

template<class TInput1 , class TInput2 >
typedef TInput1 otb::MRFEnergy< TInput1, TInput2 >::InputImageType

Definition at line 51 of file otbMRFEnergy.h.

◆ InputNeighborhoodIterator

template<class TInput1 , class TInput2 >
typedef itk::ConstNeighborhoodIterator<InputImageType> otb::MRFEnergy< TInput1, TInput2 >::InputNeighborhoodIterator

Definition at line 57 of file otbMRFEnergy.h.

◆ LabelledImagePixelType

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

Definition at line 54 of file otbMRFEnergy.h.

◆ LabelledImageType

template<class TInput1 , class TInput2 >
typedef TInput2 otb::MRFEnergy< TInput1, TInput2 >::LabelledImageType

Definition at line 52 of file otbMRFEnergy.h.

◆ LabelledNeighborhoodIterator

template<class TInput1 , class TInput2 >
typedef itk::ConstNeighborhoodIterator<LabelledImageType> otb::MRFEnergy< TInput1, TInput2 >::LabelledNeighborhoodIterator

Definition at line 56 of file otbMRFEnergy.h.

◆ ParametersType

template<class TInput1 , class TInput2 >
typedef itk::Array<double> otb::MRFEnergy< TInput1, TInput2 >::ParametersType

Definition at line 59 of file otbMRFEnergy.h.

◆ Pointer

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

Definition at line 48 of file otbMRFEnergy.h.

◆ Self

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

Definition at line 46 of file otbMRFEnergy.h.

◆ Superclass

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

Definition at line 47 of file otbMRFEnergy.h.

Constructor & Destructor Documentation

◆ MRFEnergy()

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

Definition at line 140 of file otbMRFEnergy.h.

◆ ~MRFEnergy()

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

Definition at line 141 of file otbMRFEnergy.h.

Member Function Documentation

◆ CreateAnother()

template<class TInput1 , class TInput2 >
virtual::itk::LightObject::Pointer otb::MRFEnergy< TInput1, TInput2 >::CreateAnother ( void  ) const

◆ GetNameOfClass()

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

◆ GetNumberOfParameters()

template<class TInput1 , class TInput2 >
virtual unsigned int otb::MRFEnergy< TInput1, TInput2 >::GetNumberOfParameters ( ) const
virtual

◆ GetParameters()

template<class TInput1 , class TInput2 >
const ParametersType& otb::MRFEnergy< TInput1, TInput2 >::GetParameters ( void  ) const
inline

Definition at line 69 of file otbMRFEnergy.h.

◆ GetSingleValue()

template<class TInput1 , class TInput2 >
virtual double otb::MRFEnergy< TInput1, TInput2 >::GetSingleValue ( const InputImagePixelType ,
const LabelledImagePixelType  
)
inlinevirtual

◆ GetValue() [1/3]

template<class TInput1 , class TInput2 >
virtual double otb::MRFEnergy< TInput1, TInput2 >::GetValue ( const InputImagePixelType value1,
const LabelledImagePixelType value2 
)
inlinevirtual

Definition at line 89 of file otbMRFEnergy.h.

◆ GetValue() [2/3]

template<class TInput1 , class TInput2 >
virtual double otb::MRFEnergy< TInput1, TInput2 >::GetValue ( const InputNeighborhoodIterator it,
const LabelledImagePixelType value2 
)
inlinevirtual

Definition at line 116 of file otbMRFEnergy.h.

◆ GetValue() [3/3]

template<class TInput1 , class TInput2 >
virtual double otb::MRFEnergy< TInput1, TInput2 >::GetValue ( const LabelledNeighborhoodIterator it,
const LabelledImagePixelType value2 
)
inlinevirtual

Definition at line 94 of file otbMRFEnergy.h.

◆ New()

template<class TInput1 , class TInput2 >
static Pointer otb::MRFEnergy< TInput1, TInput2 >::New ( )
static

◆ SetNumberOfParameters()

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

◆ SetParameters()

template<class TInput1 , class TInput2 >
void otb::MRFEnergy< TInput1, TInput2 >::SetParameters ( const ParametersType parameters)
inline

Definition at line 74 of file otbMRFEnergy.h.

Member Data Documentation

◆ m_NumberOfParameters

template<class TInput1 , class TInput2 >
unsigned int otb::MRFEnergy< TInput1, TInput2 >::m_NumberOfParameters
protected

Definition at line 144 of file otbMRFEnergy.h.

◆ m_Parameters

template<class TInput1 , class TInput2 >
ParametersType otb::MRFEnergy< TInput1, TInput2 >::m_Parameters
protected

Definition at line 145 of file otbMRFEnergy.h.


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