OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::MRFOptimizerMetropolis Class Reference

#include <otbMRFOptimizerMetropolis.h>

+ Inheritance diagram for otb::MRFOptimizerMetropolis:
+ Collaboration diagram for otb::MRFOptimizerMetropolis:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::Statistics::MersenneTwisterRandomVariateGenerator RandomGeneratorType
 
typedef MRFOptimizerMetropolis Self
 
typedef MRFOptimizer Superclass
 
- Public Types inherited from otb::MRFOptimizer
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::Array< double > ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef MRFOptimizer Self
 
typedef itk::Object Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::MRFOptimizer
virtual unsigned int GetNumberOfParameters () const
 
const ParametersTypeGetParameters (void) const
 
virtual void SetParameters (const ParametersType &parameters)
 

Static Public Member Functions

static Pointer New ()
 
RandomGeneratorType::Pointer m_Generator
 
void SetSingleParameter (double parameterVal)
 
bool Compute (double deltaEnergy) override
 
void InitializeSeed (int seed)
 
void InitializeSeed ()
 
 MRFOptimizerMetropolis ()
 
 ~MRFOptimizerMetropolis () override
 

Additional Inherited Members

- Protected Member Functions inherited from otb::MRFOptimizer
 MRFOptimizer ()
 
 ~MRFOptimizer () override
 
- Protected Attributes inherited from otb::MRFOptimizer
unsigned int m_NumberOfParameters
 
ParametersType m_Parameters
 

Detailed Description

This is the optimizer class implementing the Metropolis algorithm.

This is one optimizer to be used in the MRF framework. This optimizer follows the metropolis algorithm to accept of reject the value proposed by the sampler.

The MRFOptimizerMetropolis has one parameter corresponding to the temperature T used to accept or reject proposed values. The proposed value is accepted with a probability:

\[ e^{\frac{-\Delta E}{T}} \]

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

Examples
Markov/MarkovClassification1Example.cxx, Markov/MarkovRegularizationExample.cxx, and Markov/MarkovRestorationExample.cxx.

Definition at line 51 of file otbMRFOptimizerMetropolis.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::MRFOptimizerMetropolis::ConstPointer

Definition at line 57 of file otbMRFOptimizerMetropolis.h.

◆ ParametersType

typedef Superclass::ParametersType otb::MRFOptimizerMetropolis::ParametersType

Definition at line 58 of file otbMRFOptimizerMetropolis.h.

◆ Pointer

typedef itk::SmartPointer<Self> otb::MRFOptimizerMetropolis::Pointer

Definition at line 56 of file otbMRFOptimizerMetropolis.h.

◆ RandomGeneratorType

typedef itk::Statistics::MersenneTwisterRandomVariateGenerator otb::MRFOptimizerMetropolis::RandomGeneratorType

Definition at line 60 of file otbMRFOptimizerMetropolis.h.

◆ Self

Definition at line 54 of file otbMRFOptimizerMetropolis.h.

◆ Superclass

Definition at line 55 of file otbMRFOptimizerMetropolis.h.

Constructor & Destructor Documentation

◆ MRFOptimizerMetropolis()

otb::MRFOptimizerMetropolis::MRFOptimizerMetropolis ( )
inlineprotected

Set parameter to a one array filled with paramVal.

Definition at line 108 of file otbMRFOptimizerMetropolis.h.

◆ ~MRFOptimizerMetropolis()

otb::MRFOptimizerMetropolis::~MRFOptimizerMetropolis ( )
inlineoverrideprotected

Set parameter to a one array filled with paramVal.

Definition at line 116 of file otbMRFOptimizerMetropolis.h.

Member Function Documentation

◆ Compute()

bool otb::MRFOptimizerMetropolis::Compute ( double  deltaEnergy)
inlineoverridevirtual

Set parameter to a one array filled with paramVal.

Implements otb::MRFOptimizer.

Definition at line 75 of file otbMRFOptimizerMetropolis.h.

◆ CreateAnother()

virtual::itk::LightObject::Pointer otb::MRFOptimizerMetropolis::CreateAnother ( void  ) const

◆ GetNameOfClass()

virtual const char* otb::MRFOptimizerMetropolis::GetNameOfClass ( ) const
virtual

Reimplemented from otb::MRFOptimizer.

◆ InitializeSeed() [1/2]

void otb::MRFOptimizerMetropolis::InitializeSeed ( )
inline

Set parameter to a one array filled with paramVal.

Definition at line 101 of file otbMRFOptimizerMetropolis.h.

◆ InitializeSeed() [2/2]

void otb::MRFOptimizerMetropolis::InitializeSeed ( int  seed)
inline

Methods to cancel random effects.

Definition at line 97 of file otbMRFOptimizerMetropolis.h.

◆ New()

static Pointer otb::MRFOptimizerMetropolis::New ( )
static

◆ SetSingleParameter()

void otb::MRFOptimizerMetropolis::SetSingleParameter ( double  parameterVal)
inline

Set parameter to a one array filled with paramVal.

Definition at line 67 of file otbMRFOptimizerMetropolis.h.

Member Data Documentation

◆ m_Generator

RandomGeneratorType::Pointer otb::MRFOptimizerMetropolis::m_Generator
protected

Set parameter to a one array filled with paramVal.

Definition at line 119 of file otbMRFOptimizerMetropolis.h.


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