OTB  6.7.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 Self
ConstPointer
 
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 Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 MRFSampler ()
 
 ~MRFSampler () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

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
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

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

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

Definition at line 51 of file otbMRFSampler.h.

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

Definition at line 64 of file otbMRFSampler.h.

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

Definition at line 61 of file otbMRFSampler.h.

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

Definition at line 65 of file otbMRFSampler.h.

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

Definition at line 62 of file otbMRFSampler.h.

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

Definition at line 54 of file otbMRFSampler.h.

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

Definition at line 55 of file otbMRFSampler.h.

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

Definition at line 58 of file otbMRFSampler.h.

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

Definition at line 59 of file otbMRFSampler.h.

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

Definition at line 50 of file otbMRFSampler.h.

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

Definition at line 48 of file otbMRFSampler.h.

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

Definition at line 49 of file otbMRFSampler.h.

Constructor & Destructor Documentation

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

Definition at line 103 of file otbMRFSampler.h.

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

Definition at line 114 of file otbMRFSampler.h.

Member Function Documentation

template<class TInput1 , class TInput2 >
virtual int otb::MRFSampler< TInput1, TInput2 >::Compute ( const InputImageNeighborhoodIterator itData,
const LabelledImageNeighborhoodIterator itRegul 
)
pure virtual
template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetDeltaEnergy ( )
virtual
template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetEnergyAfter ( ) const
virtual
template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetEnergyBefore ( ) const
virtual
template<class TInput1 , class TInput2 >
virtual double otb::MRFSampler< TInput1, TInput2 >::GetLambda ( )
virtual
template<class TInput1 , class TInput2 >
virtual const char* otb::MRFSampler< TInput1, TInput2 >::GetNameOfClass ( ) const
virtual
template<class TInput1 , class TInput2 >
virtual unsigned int otb::MRFSampler< TInput1, TInput2 >::GetNumberOfClasses ( )
virtual
template<class TInput1 , class TInput2 >
virtual LabelledImagePixelType otb::MRFSampler< TInput1, TInput2 >::GetValue ( )
virtual
template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetEnergyFidelity ( EnergyFidelityType _arg)
virtual
template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetEnergyRegularization ( EnergyRegularizationType _arg)
virtual
template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetLambda ( double  _arg)
virtual
template<class TInput1 , class TInput2 >
virtual void otb::MRFSampler< TInput1, TInput2 >::SetNumberOfClasses ( unsigned int  _arg)
virtual

Member Data Documentation

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

Definition at line 92 of file otbMRFSampler.h.

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

Definition at line 91 of file otbMRFSampler.h.

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

Definition at line 90 of file otbMRFSampler.h.

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

Definition at line 93 of file otbMRFSampler.h.

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

Definition at line 98 of file otbMRFSampler.h.

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

Definition at line 97 of file otbMRFSampler.h.

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

Definition at line 94 of file otbMRFSampler.h.

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

Definition at line 89 of file otbMRFSampler.h.

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

Definition at line 96 of file otbMRFSampler.h.

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

Definition at line 99 of file otbMRFSampler.h.


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