ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::ExhaustiveOptimizerv4< TInternalComputationValueType > Class Template Reference

#include <itkExhaustiveOptimizerv4.h>

+ Inheritance diagram for itk::ExhaustiveOptimizerv4< TInternalComputationValueType >:
+ Collaboration diagram for itk::ExhaustiveOptimizerv4< TInternalComputationValueType >:

Detailed Description

template<typename TInternalComputationValueType>
class itk::ExhaustiveOptimizerv4< TInternalComputationValueType >

Optimizer that fully samples a grid on the parametric space.

This optimizer is equivalent to an exahaustive 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 an array of number of steps.

A typical use is to plot the metric space to get an idea of how noisy it is. An example is given below, where it is desired to plot the metric space with respect to translations along x, y and z in a 3D registration application: Here it is assumed that the transform is Euler3DTransform.

* OptimizerType::StepsType steps( m_Transform->GetNumberOfParameters() );
* steps[0] = 10;
* steps[1] = 10;
* steps[2] = 10;
* m_Optimizer->SetNumberOfSteps( steps );
* m_Optimizer->SetStepLength( 2 );
*

The optimizer throws IterationEvents after every iteration. We use this to plot the metric space in an image as follows:

* if( itk::IterationEvent().CheckEvent(& event ) )
* {
* IndexType index;
* index[0] = m_Optimizer->GetCurrentIndex()[0];
* index[1] = m_Optimizer->GetCurrentIndex()[1];
* index[2] = m_Optimizer->GetCurrentIndex()[2];
* image->SetPixel( index, m_Optimizer->GetCurrentValue() );
* }
*

The image size is expected to be 11 x 11 x 11.

If you wish to use different step lengths along each parametric axis, you can use the SetScales() method. This accepts an array, each element represents the number of subdivisions per step length. For instance scales of [0.5 1 4] along with a step length of 2 will cause the optimizer to search the metric space on a grid with x,y,z spacing of [1 2 8].

Physical dimensions of the grid are influenced by both the scales and the number of steps along each dimension, a side of the region is stepLength*(2*numberOfSteps[d]+1)*scaling[d].

Examples:
WikiExamples/Registration/ExhaustiveOptimizer.cxx.

Definition at line 78 of file itkExhaustiveOptimizerv4.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef ExhaustiveOptimizerv4 Self
 
typedef Array< SizeValueTypeStepsType
 
typedef
ObjectToObjectOptimizerBaseTemplate
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef MetricType::DerivativeType DerivativeType
 
typedef MetricType::MeasureType MeasureType
 
typedef
ObjectToObjectMetricBaseTemplate
< TInternalComputationValueType > 
MetricType
 
typedef MetricType::Pointer MetricTypePointer
 
typedef
MetricType::NumberOfParametersType 
NumberOfParametersType
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
OptimizerParameterScalesEstimatorTemplate
< TInternalComputationValueType > 
ScalesEstimatorType
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ScalesType
 
typedef
ObjectToObjectOptimizerBaseTemplate 
Self
 
typedef std::ostringstream StopConditionDescriptionType
 
typedef std::string StopConditionReturnStringType
 
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 () const
 
virtual const ParametersTypeGetCurrentIndex () const
 
virtual const MeasureTypeGetCurrentValue () const
 
ParametersTypeGetInitialPosition (void)
 
virtual const MeasureTypeGetMaximumMetricValue () const
 
virtual const ParametersTypeGetMaximumMetricValuePosition () const
 
virtual const MeasureTypeGetMinimumMetricValue () const
 
virtual const ParametersTypeGetMinimumMetricValuePosition () const
 
virtual const char * GetNameOfClass () const
 
virtual const StepsTypeGetNumberOfSteps () const
 
virtual const double & GetStepLength () const
 
virtual const std::string GetStopConditionDescription () const override
 
void ResumeWalking ()
 
void SetInitialPosition (const ParametersType &param)
 
virtual void SetNumberOfSteps (StepsType _arg)
 
virtual void SetStepLength (double _arg)
 
virtual void StartOptimization (bool doOnlyInitialization=false) override
 
void StartWalking ()
 
void StopWalking ()
 
- Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
virtual SizeValueType GetCurrentIteration () const
 
virtual const MeasureTypeGetCurrentMetricValue () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
virtual SizeValueType GetNumberOfIterations () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual const ScalesTypeGetScales () const
 
virtual const bool & GetScalesAreIdentity () const
 
bool GetScalesInitialized () const
 
virtual const MeasureTypeGetValue () const
 
virtual const ScalesTypeGetWeights () const
 
virtual const bool & GetWeightsAreIdentity () const
 
virtual void SetNumberOfIterations (SizeValueType _arg)
 
virtual void SetNumberOfThreads (ThreadIdType number)
 
virtual void SetScalesEstimator (ScalesEstimatorType *_arg)
 
virtual void SetWeights (ScalesType _arg)
 
virtual void SetMetric (MetricType *_arg)
 
virtual MetricTypeGetModifiableMetric ()
 
virtual const MetricTypeGetMetric () const
 
virtual void SetScales (const ScalesType &scales)
 
virtual void SetDoEstimateScales (bool _arg)
 
virtual const bool & GetDoEstimateScales () const
 
virtual void DoEstimateScalesOn ()
 
virtual void DoEstimateScalesOff ()
 
- 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
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () 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 SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- 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::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

void AdvanceOneStep ()
 
 ExhaustiveOptimizerv4 ()
 
void IncrementIndex (ParametersType &param)
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~ExhaustiveOptimizerv4 ()
 
- Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
 ObjectToObjectOptimizerBaseTemplate ()
 
virtual ~ObjectToObjectOptimizerBaseTemplate ()
 
- 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
 
MeasureType m_CurrentValue
 
ParametersType m_InitialPosition
 
MeasureType m_MaximumMetricValue
 
ParametersType m_MaximumMetricValuePosition
 
MeasureType m_MinimumMetricValue
 
ParametersType m_MinimumMetricValuePosition
 
StepsType m_NumberOfSteps
 
double m_StepLength
 
bool m_Stop
 
- Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
SizeValueType m_CurrentIteration
 
MeasureType m_CurrentMetricValue
 
bool m_DoEstimateScales
 
MetricTypePointer m_Metric
 
SizeValueType m_NumberOfIterations
 
ThreadIdType m_NumberOfThreads
 
ScalesType m_Scales
 
bool m_ScalesAreIdentity
 
ScalesEstimatorType::Pointer m_ScalesEstimator
 
ScalesType m_Weights
 
bool m_WeightsAreIdentity
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 ExhaustiveOptimizerv4 (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

std::ostringstream m_StopConditionDescription
 

Member Typedef Documentation

template<typename TInternalComputationValueType >
typedef SmartPointer< const Self > itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::ConstPointer

Definition at line 86 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::MeasureType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::MeasureType

Measure type

Definition at line 98 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::ParametersType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::ParametersType

Parameters type

Definition at line 101 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef SmartPointer< Self > itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::Pointer

Definition at line 85 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::ScalesType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::ScalesType

Scales type

Definition at line 104 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef ExhaustiveOptimizerv4 itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::Self

Standard "Self" typedef.

Definition at line 83 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Array< SizeValueType > itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::StepsType

Steps type

Definition at line 92 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::Superclass

Definition at line 84 of file itkExhaustiveOptimizerv4.h.

Constructor & Destructor Documentation

template<typename TInternalComputationValueType >
itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::ExhaustiveOptimizerv4 ( )
protected
template<typename TInternalComputationValueType >
virtual itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::~ExhaustiveOptimizerv4 ( )
inlineprotectedvirtual

Definition at line 142 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::ExhaustiveOptimizerv4 ( const Self )
private

Member Function Documentation

template<typename TInternalComputationValueType >
void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::AdvanceOneStep ( )
protected

Advance to the next grid position.

template<typename TInternalComputationValueType >
virtual::itk::LightObject::Pointer itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TInternalComputationValueType >
virtual const ParametersType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetCurrentIndex ( ) const
virtual
template<typename TInternalComputationValueType >
virtual const MeasureType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetCurrentValue ( ) const
virtual
template<typename TInternalComputationValueType >
ParametersType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetInitialPosition ( void  )
inline

Get the position to initialize the optimization.

Definition at line 135 of file itkExhaustiveOptimizerv4.h.

References itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_InitialPosition.

template<typename TInternalComputationValueType >
virtual const MeasureType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetMaximumMetricValue ( ) const
virtual
template<typename TInternalComputationValueType >
virtual const ParametersType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetMaximumMetricValuePosition ( ) const
virtual
template<typename TInternalComputationValueType >
virtual const MeasureType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetMinimumMetricValue ( ) const
virtual
template<typename TInternalComputationValueType >
virtual const ParametersType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetMinimumMetricValuePosition ( ) const
virtual
template<typename TInternalComputationValueType >
virtual const char* itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
virtual const StepsType& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetNumberOfSteps ( ) const
virtual
template<typename TInternalComputationValueType >
virtual const double& itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetStepLength ( ) const
virtual
template<typename TInternalComputationValueType >
virtual const std::string itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::GetStopConditionDescription ( ) const
overridevirtual
template<typename TInternalComputationValueType >
void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::IncrementIndex ( ParametersType param)
protected
template<typename TInternalComputationValueType >
static Pointer itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::New ( )
static

Method for creation through the object factory.

template<typename TInternalComputationValueType >
void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::operator= ( const Self )
private
template<typename TInternalComputationValueType >
virtual void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::ResumeWalking ( )

Resume the optimization

template<typename TInternalComputationValueType >
void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::SetInitialPosition ( const ParametersType param)

Set the position to initialize the optimization.

template<typename TInternalComputationValueType >
virtual void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::SetNumberOfSteps ( StepsType  _arg)
virtual
template<typename TInternalComputationValueType >
virtual void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::SetStepLength ( double  _arg)
virtual
template<typename TInternalComputationValueType >
virtual void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::StartOptimization ( bool  doOnlyInitialization = false)
overridevirtual

Run the optimization.

Parameters
doOnlyInitializationThis is false by default. It should only be set to true for special cases when the class should be initialized to perform optimization, but no optimization should be run. For example, itkMultiGradientOptimizerv4 needs to do this.
Note
Derived classes must override and call this superclass method, then perform any additional initialization before performing optimization.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::StartWalking ( )

Start optimization

template<typename TInternalComputationValueType >
void itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::StopWalking ( )

Stop optimization

Member Data Documentation

template<typename TInternalComputationValueType >
ParametersType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_CurrentIndex
protected

Definition at line 156 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
MeasureType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_CurrentValue
protected

Definition at line 152 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
ParametersType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_InitialPosition
protected
template<typename TInternalComputationValueType >
MeasureType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_MaximumMetricValue
protected

Definition at line 157 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
ParametersType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_MaximumMetricValuePosition
protected

Definition at line 160 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
MeasureType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_MinimumMetricValue
protected

Definition at line 158 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
ParametersType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_MinimumMetricValuePosition
protected

Definition at line 159 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
StepsType itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_NumberOfSteps
protected

Definition at line 153 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
double itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_StepLength
protected

Definition at line 155 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
bool itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_Stop
protected

Definition at line 154 of file itkExhaustiveOptimizerv4.h.

template<typename TInternalComputationValueType >
std::ostringstream itk::ExhaustiveOptimizerv4< TInternalComputationValueType >::m_StopConditionDescription
private

Definition at line 166 of file itkExhaustiveOptimizerv4.h.


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