itk::ExhaustiveOptimizer Class Reference
[Numerics]

#include <itkExhaustiveOptimizer.h>

Inheritance diagram for itk::ExhaustiveOptimizer:

[legend]Collaboration diagram for itk::ExhaustiveOptimizer:

[legend]List of all members.

---

Detailed Description

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 parameters are define through an array of minimum and maximum values. The subdivisions of the grid along each one of the dimensions of the parametric space is defined by an array of number of steps. This optimizer is useful when its needed to plot the entire metric space to get an idea of how noisy it is etc...

A typical use of the optimizer 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[1] = 0;  
 steps[2] = 0;  
 steps[3] = 0;  
 steps[3] = 10;
 steps[4] = 10;
 steps[5] = 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()[3];
    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 21 x 21 x 21 with a spacing of 2.

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 0 0 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].

Optimizers

Definition at line 81 of file itkExhaustiveOptimizer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef SingleValuedCostFunction	CostFunctionType
typedef CostFunctionType::DerivativeType	DerivativeType
typedef CostFunctionType::MeasureType	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef ExhaustiveOptimizer	Self
typedef Array< unsigned long >	StepsType
typedef SingleValuedNonLinearOptimizer	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
virtual const CostFunctionType *	GetCostFunction ()
virtual const ParametersType &	GetCurrentIndex ()
virtual const ParametersType &	GetCurrentPosition ()
virtual const MeasureType &	GetCurrentValue ()
bool	GetDebug () const
virtual const ParametersType &	GetInitialPosition ()
virtual const MeasureType &	GetMaximumMetricValue ()
virtual const ParametersType &	GetMaximumMetricValuePosition ()
virtual const unsigned long &	GetMaximumNumberOfIterations ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual const MeasureType &	GetMinimumMetricValue ()
virtual const ParametersType &	GetMinimumMetricValuePosition ()
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const StepsType &	GetNumberOfSteps ()
virtual int	GetReferenceCount () const
virtual const ScalesType &	GetScales ()
virtual const double &	GetStepLength ()
MeasureType	GetValue (const ParametersType &parameters) const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	ResumeWalking (void)
virtual void	SetCostFunction (CostFunctionType *costFunction)
void	SetDebug (bool debugFlag) const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNumberOfSteps (StepsType _arg)
virtual void	SetReferenceCount (int)
void	SetScales (const ScalesType &scales)
virtual void	SetStepLength (double _arg)
virtual void	StartOptimization (void)
void	StartWalking (void)
void	StopWalking (void)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
Advance one step following the gradient direction *This method verifies if a change in direction is required *and if a reduction in steplength is required *void	AdvanceOneStep (void)
	ExhaustiveOptimizer ()
void	IncrementIndex (ParametersType &param)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	SetCurrentPosition (const ParametersType &param)
virtual	~ExhaustiveOptimizer ()
Protected Attributes
CostFunctionPointer	m_CostFunction
ParametersType	m_CurrentIndex
unsigned long	m_CurrentIteration
unsigned int	m_CurrentParameter
MeasureType	m_CurrentValue
MeasureType	m_MaximumMetricValue
ParametersType	m_MaximumMetricValuePosition
unsigned long	m_MaximumNumberOfIterations
MeasureType	m_MinimumMetricValue
ParametersType	m_MinimumMetricValuePosition
StepsType	m_NumberOfSteps
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_ScalesInitialized
double	m_StepLength
bool	m_Stop
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::ExhaustiveOptimizer::ConstPointer

Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 89 of file itkExhaustiveOptimizer.h.

typedef CostFunctionType::Pointer itk::SingleValuedNonLinearOptimizer::CostFunctionPointer [inherited]

Reimplemented in itk::FRPROptimizer, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer. Definition at line 56 of file itkSingleValuedNonLinearOptimizer.h.

typedef SingleValuedCostFunction itk::SingleValuedNonLinearOptimizer::CostFunctionType [inherited]

Type of the Cost Function Reimplemented in itk::FRPROptimizer, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, and itk::RegularStepGradientDescentOptimizer. Definition at line 55 of file itkSingleValuedNonLinearOptimizer.h.

typedef CostFunctionType::DerivativeType itk::SingleValuedNonLinearOptimizer::DerivativeType [inherited]

Derivative type. It defines a type used to return the cost function derivative. Definition at line 64 of file itkSingleValuedNonLinearOptimizer.h.

typedef CostFunctionType::MeasureType itk::SingleValuedNonLinearOptimizer::MeasureType [inherited]

Measure type. It defines a type used to return the cost function value. Reimplemented in itk::LBFGSBOptimizer. Definition at line 60 of file itkSingleValuedNonLinearOptimizer.h.

typedef Superclass::ParametersType itk::SingleValuedNonLinearOptimizer::ParametersType [inherited]

Parameters type. It defines a position in the optimization search space. Reimplemented from itk::NonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::FRPROptimizer, itk::PowellOptimizer, and itk::QuaternionRigidTransformGradientDescentOptimizer. Definition at line 48 of file itkSingleValuedNonLinearOptimizer.h.

typedef SmartPointer<Self> itk::ExhaustiveOptimizer::Pointer

Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 88 of file itkExhaustiveOptimizer.h.

typedef Superclass::ScalesType itk::NonLinearOptimizer::ScalesType [inherited]

Scale type. This array defines scale to be applied to parameters before being evaluated in the cost function. This allows to map to a more convenient space. In particular this is used to normalize parameter spaces in which some parameters have a different dynamic range. Reimplemented from itk::Optimizer. Definition at line 52 of file itkNonLinearOptimizer.h.

typedef ExhaustiveOptimizer itk::ExhaustiveOptimizer::Self

Standard "Self" typedef. Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 86 of file itkExhaustiveOptimizer.h.

typedef Array< unsigned long > itk::ExhaustiveOptimizer::StepsType

Definition at line 91 of file itkExhaustiveOptimizer.h.

typedef SingleValuedNonLinearOptimizer itk::ExhaustiveOptimizer::Superclass

Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 87 of file itkExhaustiveOptimizer.h.

---

Constructor & Destructor Documentation

itk::ExhaustiveOptimizer::ExhaustiveOptimizer (   )  [protected]

virtual itk::ExhaustiveOptimizer::~ExhaustiveOptimizer (   )  [inline, protected, virtual]

Definition at line 119 of file itkExhaustiveOptimizer.h.

---

Member Function Documentation

Advance one step following the gradient direction* This method verifies if a change in direction is required* and if a reduction in steplength is required* void itk::ExhaustiveOptimizer::AdvanceOneStep (  void   )  [protected]

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

virtual const CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetCostFunction (   )  [virtual, inherited]

Get the cost function.

virtual const ParametersType& itk::ExhaustiveOptimizer::GetCurrentIndex (   )  [virtual]

virtual const ParametersType& itk::Optimizer::GetCurrentPosition (   )  [virtual, inherited]

Get current position of the optimization.

virtual const MeasureType& itk::ExhaustiveOptimizer::GetCurrentValue (   )  [virtual]

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

virtual const ParametersType& itk::Optimizer::GetInitialPosition (   )  [virtual, inherited]

Get the position to initialize the optimization.

virtual const MeasureType& itk::ExhaustiveOptimizer::GetMaximumMetricValue (   )  [virtual]

virtual const ParametersType& itk::ExhaustiveOptimizer::GetMaximumMetricValuePosition (   )  [virtual]

virtual const unsigned long& itk::ExhaustiveOptimizer::GetMaximumNumberOfIterations (   )  [virtual]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual const MeasureType& itk::ExhaustiveOptimizer::GetMinimumMetricValue (   )  [virtual]

virtual const ParametersType& itk::ExhaustiveOptimizer::GetMinimumMetricValuePosition (   )  [virtual]

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

virtual const char* itk::ExhaustiveOptimizer::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SingleValuedNonLinearOptimizer.

virtual const StepsType& itk::ExhaustiveOptimizer::GetNumberOfSteps (   )  [virtual]

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

virtual const ScalesType& itk::Optimizer::GetScales (   )  [virtual, inherited]

Get current parameters scaling.

virtual const double& itk::ExhaustiveOptimizer::GetStepLength (   )  [virtual]

MeasureType itk::SingleValuedNonLinearOptimizer::GetValue (  const ParametersType &  parameters  )  const [inherited]

Get the cost function value at the given parameters. Reimplemented in itk::SPSAOptimizer.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::ExhaustiveOptimizer::IncrementIndex (  ParametersType &  param  )  [protected]

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::ExhaustiveOptimizer::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::SingleValuedNonLinearOptimizer.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

void itk::ExhaustiveOptimizer::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::SingleValuedNonLinearOptimizer.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::ExhaustiveOptimizer::ResumeWalking (  void   )

virtual void itk::SingleValuedNonLinearOptimizer::SetCostFunction (  CostFunctionType *  costFunction  )  [virtual, inherited]

Set the cost function.

virtual void itk::Optimizer::SetCurrentPosition (  const ParametersType &  param  )  [protected, virtual, inherited]

Set the current position.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::Optimizer::SetInitialPosition (  const ParametersType &  param  )  [virtual, inherited]

Set the position to initialize the optimization.

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::ExhaustiveOptimizer::SetNumberOfSteps (  StepsType  _arg  )  [virtual]

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

void itk::Optimizer::SetScales (  const ScalesType &  scales  )  [inherited]

Set current parameters scaling. Reimplemented in itk::LBFGSBOptimizer.

virtual void itk::ExhaustiveOptimizer::SetStepLength (  double  _arg  )  [virtual]

virtual void itk::ExhaustiveOptimizer::StartOptimization (  void   )  [virtual]

Start optimization. Reimplemented from itk::Optimizer.

void itk::ExhaustiveOptimizer::StartWalking (  void   )

void itk::ExhaustiveOptimizer::StopWalking (  void   )

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction [protected, inherited]

Definition at line 80 of file itkSingleValuedNonLinearOptimizer.h.

ParametersType itk::ExhaustiveOptimizer::m_CurrentIndex [protected]

Definition at line 142 of file itkExhaustiveOptimizer.h.

unsigned long itk::ExhaustiveOptimizer::m_CurrentIteration [protected]

Definition at line 138 of file itkExhaustiveOptimizer.h.

unsigned int itk::ExhaustiveOptimizer::m_CurrentParameter [protected]

Definition at line 140 of file itkExhaustiveOptimizer.h.

MeasureType itk::ExhaustiveOptimizer::m_CurrentValue [protected]

Definition at line 136 of file itkExhaustiveOptimizer.h.

MeasureType itk::ExhaustiveOptimizer::m_MaximumMetricValue [protected]

Definition at line 144 of file itkExhaustiveOptimizer.h.

ParametersType itk::ExhaustiveOptimizer::m_MaximumMetricValuePosition [protected]

Definition at line 147 of file itkExhaustiveOptimizer.h.

unsigned long itk::ExhaustiveOptimizer::m_MaximumNumberOfIterations [protected]

Definition at line 143 of file itkExhaustiveOptimizer.h.

MeasureType itk::ExhaustiveOptimizer::m_MinimumMetricValue [protected]

Definition at line 145 of file itkExhaustiveOptimizer.h.

ParametersType itk::ExhaustiveOptimizer::m_MinimumMetricValuePosition [protected]

Definition at line 146 of file itkExhaustiveOptimizer.h.

StepsType itk::ExhaustiveOptimizer::m_NumberOfSteps [protected]

Definition at line 137 of file itkExhaustiveOptimizer.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

bool itk::Optimizer::m_ScalesInitialized [protected, inherited]

Definition at line 90 of file itkOptimizer.h.

double itk::ExhaustiveOptimizer::m_StepLength [protected]

Definition at line 141 of file itkExhaustiveOptimizer.h.

bool itk::ExhaustiveOptimizer::m_Stop [protected]

Definition at line 139 of file itkExhaustiveOptimizer.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkExhaustiveOptimizer.h

---