OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::ExhaustiveExponentialOptimizer Class Reference

#include <otbExhaustiveExponentialOptimizer.h>

+ Inheritance diagram for otb::ExhaustiveExponentialOptimizer:
+ Collaboration diagram for otb::ExhaustiveExponentialOptimizer:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef
ExhaustiveExponentialOptimizer 
Self
 
typedef itk::Array< unsigned long > StepsType
 
typedef
itk::SingleValuedNonLinearOptimizer 
Superclass
 
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
CostFunctionType::DerivativeType 
DerivativeType
 
typedef
CostFunctionType::MeasureType 
MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
SingleValuedNonLinearOptimizer 
Self
 
typedef NonLinearOptimizer Superclass
 
- Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef NonLinearOptimizer Self
 
typedef Optimizer Superclass
 
- Public Types inherited from itk::Optimizer
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Array< double > ScalesType
 
typedef Optimizer Self
 
typedef 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 ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const ParametersTypeGetCurrentIndex () const
 
virtual const MeasureTypeGetCurrentValue () const
 
virtual const double & GetGeometricProgression () const
 
virtual const MeasureTypeGetMaximumMetricValue () const
 
virtual const ParametersTypeGetMaximumMetricValuePosition () const
 
virtual const unsigned long & GetMaximumNumberOfIterations () const
 
virtual const MeasureTypeGetMinimumMetricValue () const
 
virtual const ParametersTypeGetMinimumMetricValuePosition () const
 
virtual const char * GetNameOfClass () const
 
virtual const StepsTypeGetNumberOfSteps () const
 
virtual const double & GetStepLength () const
 
void ResumeWalking (void)
 
virtual void SetGeometricProgression (double _arg)
 
virtual void SetNumberOfSteps (StepsType _arg)
 
virtual void SetStepLength (double _arg)
 
virtual void StartOptimization (void)
 
void StartWalking (void)
 
void StopWalking (void)
 
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual const CostFunctionTypeGetCostFunction () const
 
virtual CostFunctionTypeGetModifiableCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersTypeGetCurrentPosition () const
 
virtual const ParametersTypeGetInitialPosition () const
 
virtual const ScalesTypeGetInverseScales () const
 
virtual const ScalesTypeGetScales () const
 
virtual const std::string GetStopConditionDescription () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
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 ITK_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) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- 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
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
static Pointer New ()
 
- Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Optimizer
static Pointer New ()
 
- 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 ()
 

Protected Member Functions

 ExhaustiveExponentialOptimizer ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
virtual ~ExhaustiveExponentialOptimizer ()
 
void AdvanceOneStep (void)
 
void IncrementIndex (ParametersType &param)
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
 SingleValuedNonLinearOptimizer ()
 
virtual ~SingleValuedNonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()
 
virtual ~NonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
virtual ~Optimizer ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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

ParametersType m_CurrentIndex
 
unsigned long m_CurrentIteration
 
unsigned int m_CurrentParameter
 
MeasureType m_CurrentValue
 
double m_GeometricProgression
 
MeasureType m_MaximumMetricValue
 
ParametersType m_MaximumMetricValuePosition
 
unsigned long m_MaximumNumberOfIterations
 
MeasureType m_MinimumMetricValue
 
ParametersType m_MinimumMetricValuePosition
 
StepsType m_NumberOfSteps
 
double m_StepLength
 
bool m_Stop
 
- Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer m_CostFunction
 
- Protected Attributes inherited from itk::Optimizer
ParametersType m_CurrentPosition
 
bool m_ScalesInitialized
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

 ExhaustiveExponentialOptimizer (const Self &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Detailed Description

This optimizer performs an exhaustive search on an exponential scale.

This optimizer is equivalent to an exhaustive search in a discrete grid defined over the parametric space. The grid is centered on the initial position. The subdivisions of the grid along each one of the dimensions of the parametric space is defined by a exponential progression with scale factor m_ScaleFactor, with the exponant following an arithmetic progression from 0 to m_NumberOfSteps * m_StepLength in both positive and negative direction.

This optimizer can be use to perform a preliminary coarse search on the search space.

Definition at line 44 of file otbExhaustiveExponentialOptimizer.h.

Member Typedef Documentation

Definition at line 52 of file otbExhaustiveExponentialOptimizer.h.

Definition at line 51 of file otbExhaustiveExponentialOptimizer.h.

Standard "Self" typedef.

Definition at line 49 of file otbExhaustiveExponentialOptimizer.h.

Definition at line 54 of file otbExhaustiveExponentialOptimizer.h.

Definition at line 50 of file otbExhaustiveExponentialOptimizer.h.

Constructor & Destructor Documentation

otb::ExhaustiveExponentialOptimizer::ExhaustiveExponentialOptimizer ( )
protected
virtual otb::ExhaustiveExponentialOptimizer::~ExhaustiveExponentialOptimizer ( )
inlineprotectedvirtual

Definition at line 83 of file otbExhaustiveExponentialOptimizer.h.

otb::ExhaustiveExponentialOptimizer::ExhaustiveExponentialOptimizer ( const Self )
private

Member Function Documentation

void otb::ExhaustiveExponentialOptimizer::AdvanceOneStep ( void  )
protected

Advance to the next grid position.

virtual::itk::LightObject::Pointer otb::ExhaustiveExponentialOptimizer::CreateAnother ( void  ) const
virtual
virtual const ParametersType& otb::ExhaustiveExponentialOptimizer::GetCurrentIndex ( ) const
virtual
virtual const MeasureType& otb::ExhaustiveExponentialOptimizer::GetCurrentValue ( ) const
virtual
virtual const double& otb::ExhaustiveExponentialOptimizer::GetGeometricProgression ( ) const
virtual
virtual const MeasureType& otb::ExhaustiveExponentialOptimizer::GetMaximumMetricValue ( ) const
virtual
virtual const ParametersType& otb::ExhaustiveExponentialOptimizer::GetMaximumMetricValuePosition ( ) const
virtual
virtual const unsigned long& otb::ExhaustiveExponentialOptimizer::GetMaximumNumberOfIterations ( ) const
virtual
virtual const MeasureType& otb::ExhaustiveExponentialOptimizer::GetMinimumMetricValue ( ) const
virtual
virtual const ParametersType& otb::ExhaustiveExponentialOptimizer::GetMinimumMetricValuePosition ( ) const
virtual
virtual const char* otb::ExhaustiveExponentialOptimizer::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

virtual const StepsType& otb::ExhaustiveExponentialOptimizer::GetNumberOfSteps ( ) const
virtual
virtual const double& otb::ExhaustiveExponentialOptimizer::GetStepLength ( ) const
virtual
void otb::ExhaustiveExponentialOptimizer::IncrementIndex ( ParametersType param)
protected

Advance to the next grid position.

static Pointer otb::ExhaustiveExponentialOptimizer::New ( )
static

Method for creation through the object factory.

Referenced by otb::SVMModelEstimator< InputPixelType, LabelPixelType >::OptimizeParameters().

void otb::ExhaustiveExponentialOptimizer::operator= ( const Self )
private
void otb::ExhaustiveExponentialOptimizer::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
void otb::ExhaustiveExponentialOptimizer::ResumeWalking ( void  )
virtual void otb::ExhaustiveExponentialOptimizer::SetGeometricProgression ( double  _arg)
virtual
virtual void otb::ExhaustiveExponentialOptimizer::SetNumberOfSteps ( StepsType  _arg)
virtual
virtual void otb::ExhaustiveExponentialOptimizer::SetStepLength ( double  _arg)
virtual
virtual void otb::ExhaustiveExponentialOptimizer::StartOptimization ( void  )
virtual

Reimplemented from itk::Optimizer.

void otb::ExhaustiveExponentialOptimizer::StartWalking ( void  )
void otb::ExhaustiveExponentialOptimizer::StopWalking ( void  )

Member Data Documentation

ParametersType otb::ExhaustiveExponentialOptimizer::m_CurrentIndex
protected

Definition at line 99 of file otbExhaustiveExponentialOptimizer.h.

unsigned long otb::ExhaustiveExponentialOptimizer::m_CurrentIteration
protected

Definition at line 95 of file otbExhaustiveExponentialOptimizer.h.

unsigned int otb::ExhaustiveExponentialOptimizer::m_CurrentParameter
protected

Definition at line 97 of file otbExhaustiveExponentialOptimizer.h.

MeasureType otb::ExhaustiveExponentialOptimizer::m_CurrentValue
protected

Definition at line 92 of file otbExhaustiveExponentialOptimizer.h.

double otb::ExhaustiveExponentialOptimizer::m_GeometricProgression
protected

Definition at line 98 of file otbExhaustiveExponentialOptimizer.h.

MeasureType otb::ExhaustiveExponentialOptimizer::m_MaximumMetricValue
protected

Definition at line 101 of file otbExhaustiveExponentialOptimizer.h.

ParametersType otb::ExhaustiveExponentialOptimizer::m_MaximumMetricValuePosition
protected

Definition at line 104 of file otbExhaustiveExponentialOptimizer.h.

unsigned long otb::ExhaustiveExponentialOptimizer::m_MaximumNumberOfIterations
protected

Definition at line 100 of file otbExhaustiveExponentialOptimizer.h.

MeasureType otb::ExhaustiveExponentialOptimizer::m_MinimumMetricValue
protected

Definition at line 102 of file otbExhaustiveExponentialOptimizer.h.

ParametersType otb::ExhaustiveExponentialOptimizer::m_MinimumMetricValuePosition
protected

Definition at line 103 of file otbExhaustiveExponentialOptimizer.h.

StepsType otb::ExhaustiveExponentialOptimizer::m_NumberOfSteps
protected

Definition at line 93 of file otbExhaustiveExponentialOptimizer.h.

double otb::ExhaustiveExponentialOptimizer::m_StepLength
protected

Definition at line 94 of file otbExhaustiveExponentialOptimizer.h.

bool otb::ExhaustiveExponentialOptimizer::m_Stop
protected

Definition at line 96 of file otbExhaustiveExponentialOptimizer.h.


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