itk::OnePlusOneEvolutionaryOptimizer Class Reference
[Numerics]

#include <itkOnePlusOneEvolutionaryOptimizer.h>

Inheritance diagram for itk::OnePlusOneEvolutionaryOptimizer:

[legend]Collaboration diagram for itk::OnePlusOneEvolutionaryOptimizer:

[legend]List of all members.

---

Detailed Description

1+1 evolutionary strategy optimizer

This optimizer searches for the optimal parameters. It changes its search radius and position using the grow factor ,shrink factor, and isotropic probability function (which is a random unit normal variate generator).

This optimizer needs a cost function and a random unit normal variate generator. The cost function should return cost with new position in parameter space which will be generated by 1+1 evolutionary strategy. Users should plug-in the random unit normal variate generator using SetNormalVariateGenerator method.

The SetEpsilon method is the minimum value for the frobenius_norm of the covariance matrix. If the fnorm is smaller than this value, the optimization process will stop even before it hits the maximum iteration.

Another way to stop the optimization process is calling the StopOptimization method. At next iteration after calling it, the optimization process will stop.

This optimizing scheme was initially developed and implemented by Martin Styner, Univ. of North Carolina at Chapel Hill, and his colleagues.

For more details. refer to the following articles. "Parametric estimate of intensity inhomogeneities applied to MRI" Martin Styner, G. Gerig, Christian Brechbuehler, Gabor Szekely, IEEE TRANSACTIONS ON MEDICAL IMAGING; 19(3), pp. 153-165, 2000, (http://www.cs.unc.edu/~styner/docs/tmi00.pdf)

"Evaluation of 2D/3D bias correction with 1+1ES-optimization" Martin Styner, Prof. Dr. G. Gerig (IKT, BIWI, ETH Zuerich), TR-197 (http://www.cs.unc.edu/~styner/docs/StynerTR97.pdf)

Optimizers

See also:

NormalVariateGenerator

Definition at line 68 of file itkOnePlusOneEvolutionaryOptimizer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef SingleValuedCostFunction	CostFunctionType
typedef CostFunctionType::DerivativeType	DerivativeType
typedef CostFunctionType::MeasureType	MeasureType
typedef Statistics::RandomVariateGeneratorBase	NormalVariateGeneratorType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef OnePlusOneEvolutionaryOptimizer	Self
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 ()
Return Current Value *virtual const MeasureType &	GetCurrentCost ()
virtual const unsigned int &	GetCurrentIteration ()
virtual const ParametersType &	GetCurrentPosition ()
bool	GetDebug () const
virtual const double &	GetEpsilon ()
virtual const double &	GetFrobeniusNorm ()
virtual const double &	GetGrowthFactor ()
virtual const ParametersType &	GetInitialPosition ()
virtual const double &	GetInitialRadius ()
virtual const unsigned int &	GetMaximumIteration ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
virtual const ScalesType &	GetScales ()
virtual const double &	GetShrinkFactor ()
MeasureType	GetValue (const ParametersType &parameters) const
MeasureType	GetValue () const
bool	HasObserver (const EventObject &event) const
void	Initialize (double initialRadius, double grow=-1, double shrink=-1)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	MaximizeOff ()
virtual void	MaximizeOn ()
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetCostFunction (CostFunctionType *costFunction)
void	SetDebug (bool debugFlag) const
Set Get the minimal size of search radius *frobenius_norm of covariance matrix *virtual void	SetEpsilon (double _arg)
Set Get the search radius grow factor in parameter space *virtual void	SetGrowthFactor (double _arg)
virtual void	SetInitialPosition (const ParametersType &param)
Set Get initial search radius in parameter space *virtual void	SetInitialRadius (double _arg)
Set if the Optimizer should Maximize the metric *virtual void	SetMaximize (bool _arg)
Set Get maximum iteration limit *virtual void	SetMaximumIteration (unsigned int _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetNormalVariateGenerator (NormalVariateGeneratorType *generator)
virtual void	SetReferenceCount (int)
void	SetScales (const ScalesType &scales)
Set Get the search radius shrink factor *virtual void	SetShrinkFactor (double _arg)
void	StartOptimization ()
void	StopOptimization ()
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
	OnePlusOneEvolutionaryOptimizer (const OnePlusOneEvolutionaryOptimizer &)
	OnePlusOneEvolutionaryOptimizer ()
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	~OnePlusOneEvolutionaryOptimizer ()
Protected Attributes
CostFunctionPointer	m_CostFunction
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_ScalesInitialized
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::OnePlusOneEvolutionaryOptimizer::ConstPointer

Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 76 of file itkOnePlusOneEvolutionaryOptimizer.h.

typedef CostFunctionType::Pointer itk::OnePlusOneEvolutionaryOptimizer::CostFunctionPointer

Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 86 of file itkOnePlusOneEvolutionaryOptimizer.h.

typedef SingleValuedCostFunction itk::OnePlusOneEvolutionaryOptimizer::CostFunctionType

Type of the Cost Function Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 82 of file itkOnePlusOneEvolutionaryOptimizer.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 Statistics::RandomVariateGeneratorBase itk::OnePlusOneEvolutionaryOptimizer::NormalVariateGeneratorType

Normal random variate generator type. Definition at line 89 of file itkOnePlusOneEvolutionaryOptimizer.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::OnePlusOneEvolutionaryOptimizer::Pointer

Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 75 of file itkOnePlusOneEvolutionaryOptimizer.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 OnePlusOneEvolutionaryOptimizer itk::OnePlusOneEvolutionaryOptimizer::Self

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

typedef SingleValuedNonLinearOptimizer itk::OnePlusOneEvolutionaryOptimizer::Superclass

Reimplemented from itk::SingleValuedNonLinearOptimizer. Definition at line 74 of file itkOnePlusOneEvolutionaryOptimizer.h.

---

Constructor & Destructor Documentation

itk::OnePlusOneEvolutionaryOptimizer::OnePlusOneEvolutionaryOptimizer (   )  [protected]

itk::OnePlusOneEvolutionaryOptimizer::OnePlusOneEvolutionaryOptimizer (  const OnePlusOneEvolutionaryOptimizer &   )  [protected]

virtual itk::OnePlusOneEvolutionaryOptimizer::~OnePlusOneEvolutionaryOptimizer (   )  [protected, virtual]

---

Member Function Documentation

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.

Return Current Value* virtual const MeasureType& itk::OnePlusOneEvolutionaryOptimizer::GetCurrentCost (   )  [virtual]

virtual const unsigned int& itk::OnePlusOneEvolutionaryOptimizer::GetCurrentIteration (   )  [virtual]

Return Current Iteration

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

Get current position of the optimization.

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

Get the value of the debug flag.

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetEpsilon (   )  [virtual]

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetFrobeniusNorm (   )  [virtual]

Get the current Frobenius norm of covariance matrix

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

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetGrowthFactor (   )  [virtual]

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

Get the position to initialize the optimization.

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetInitialRadius (   )  [virtual]

virtual const unsigned int& itk::OnePlusOneEvolutionaryOptimizer::GetMaximumIteration (   )  [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 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::OnePlusOneEvolutionaryOptimizer::GetNameOfClass (   )  const [virtual]

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

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::OnePlusOneEvolutionaryOptimizer::GetShrinkFactor (   )  [virtual]

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

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

MeasureType itk::OnePlusOneEvolutionaryOptimizer::GetValue (   )  const [inline]

Definition at line 138 of file itkOnePlusOneEvolutionaryOptimizer.h.

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::OnePlusOneEvolutionaryOptimizer::Initialize (  double  initialRadius, double  grow = -1, double  shrink = -1 )

Initializes the optimizer. Before running this optimizer, this function should have been called. initialRadius: search radius in parameter space grow: search radius grow factor shrink: searhc radius shrink factor

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::OnePlusOneEvolutionaryOptimizer::MaximizeOff (   )  [virtual]

virtual void itk::OnePlusOneEvolutionaryOptimizer::MaximizeOn (   )  [virtual]

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

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.

Set Get the minimal size of search radius* frobenius_norm of covariance matrix* virtual void itk::OnePlusOneEvolutionaryOptimizer::SetEpsilon (  double  _arg  )  [virtual]

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().

Set Get the search radius grow factor in parameter space* virtual void itk::OnePlusOneEvolutionaryOptimizer::SetGrowthFactor (  double  _arg  )  [virtual]

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

Set the position to initialize the optimization.

Set Get initial search radius in parameter space* virtual void itk::OnePlusOneEvolutionaryOptimizer::SetInitialRadius (  double  _arg  )  [virtual]

Set if the Optimizer should Maximize the metric* virtual void itk::OnePlusOneEvolutionaryOptimizer::SetMaximize (  bool  _arg  )  [virtual]

Set Get maximum iteration limit* virtual void itk::OnePlusOneEvolutionaryOptimizer::SetMaximumIteration (  unsigned int  _arg  )  [virtual]

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

Returns: Set the MetaDataDictionary

void itk::OnePlusOneEvolutionaryOptimizer::SetNormalVariateGenerator (  NormalVariateGeneratorType *  generator  )

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.

Set Get the search radius shrink factor* virtual void itk::OnePlusOneEvolutionaryOptimizer::SetShrinkFactor (  double  _arg  )  [virtual]

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

Start optimization. Optimization will stop when it meets either of two termination conditions, the maximum iteration limit or epsilon (minimal search radius) Reimplemented from itk::Optimizer.

void itk::OnePlusOneEvolutionaryOptimizer::StopOptimization (  void   )  [inline]

when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration. Definition at line 152 of file itkOnePlusOneEvolutionaryOptimizer.h.

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.

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.

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:

• itkOnePlusOneEvolutionaryOptimizer.h

---