itk::SingleValuedNonLinearVnlOptimizer Class Reference
[Numerics, Optimizers]

This class is a base for the Optimization methods that optimize a single valued function. More...

#include <itkSingleValuedNonLinearVnlOptimizer.h>

Inheritance diagram for itk::SingleValuedNonLinearVnlOptimizer:

[legend]Collaboration diagram for itk::SingleValuedNonLinearVnlOptimizer:

[legend]List of all members.

Public Types
typedef SingleValuedNonLinearVnlOptimizer	Self
typedef SingleValuedNonLinearOptimizer	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef ReceptorMemberCommand< Self >	CommandType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetCostFunction (SingleValuedCostFunction *costFunction)=0
virtual const bool &	GetMaximize ()
virtual void	SetMaximize (bool _arg)
virtual void	MaximizeOn ()
virtual void	MaximizeOff ()
bool	GetMinimize () const
void	SetMinimize (bool v)
void	MinimizeOn ()
void	MinimizeOff ()
virtual const MeasureType &	GetCachedValue ()
virtual const DerivativeType &	GetCachedDerivative ()
virtual const ParametersType &	GetCachedCurrentPosition ()
Protected Types
typedef SingleValuedVnlCostFunctionAdaptor	CostFunctionAdaptorType
Protected Member Functions
	SingleValuedNonLinearVnlOptimizer ()
virtual	~SingleValuedNonLinearVnlOptimizer ()
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
const CostFunctionAdaptorType *	GetCostFunctionAdaptor (void) const
CostFunctionAdaptorType *	GetCostFunctionAdaptor (void)
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor (void) const
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

This class is a base for the Optimization methods that optimize a single valued function.

It is an Adaptor class for optimizers provided by the vnl library

Definition at line 36 of file itkSingleValuedNonLinearVnlOptimizer.h.

---

Member Typedef Documentation

typedef ReceptorMemberCommand< Self > itk::SingleValuedNonLinearVnlOptimizer::CommandType

Command observer that will interact with the ITK-VNL cost-function adaptor in order to generate iteration events. This will allow to overcome the limitation of VNL optimizers not offering callbacks for every iteration Definition at line 54 of file itkSingleValuedNonLinearVnlOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 44 of file itkSingleValuedNonLinearVnlOptimizer.h.

typedef SingleValuedVnlCostFunctionAdaptor itk::SingleValuedNonLinearVnlOptimizer::CostFunctionAdaptorType [protected]

Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 96 of file itkSingleValuedNonLinearVnlOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 43 of file itkSingleValuedNonLinearVnlOptimizer.h.

typedef SingleValuedNonLinearVnlOptimizer itk::SingleValuedNonLinearVnlOptimizer::Self

Standard class typedefs. Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 41 of file itkSingleValuedNonLinearVnlOptimizer.h.

typedef SingleValuedNonLinearOptimizer itk::SingleValuedNonLinearVnlOptimizer::Superclass

Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 42 of file itkSingleValuedNonLinearVnlOptimizer.h.

---

Constructor & Destructor Documentation

itk::SingleValuedNonLinearVnlOptimizer::SingleValuedNonLinearVnlOptimizer (   )  [protected]

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

---

Member Function Documentation

virtual const ParametersType& itk::SingleValuedNonLinearVnlOptimizer::GetCachedCurrentPosition (   )  [virtual]

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().

virtual const DerivativeType& itk::SingleValuedNonLinearVnlOptimizer::GetCachedDerivative (   )  [virtual]

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().

virtual const MeasureType& itk::SingleValuedNonLinearVnlOptimizer::GetCachedValue (   )  [virtual]

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option, for mathematical validation you should rather call GetValue().

CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor (  void   )  [protected]

const CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor (  void   )  const [protected]

virtual const bool& itk::SingleValuedNonLinearVnlOptimizer::GetMaximize (   )  [virtual]

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.

bool itk::SingleValuedNonLinearVnlOptimizer::GetMinimize (   )  const [inline]

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0. Definition at line 72 of file itkSingleValuedNonLinearVnlOptimizer.h.

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

Run-time type information (and related methods). Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer.

CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizer::GetNonConstCostFunctionAdaptor (  void   )  const [protected]

The purpose of this method is to get around the lack of const-correctness in VNL cost-functions and optimizers

virtual void itk::SingleValuedNonLinearVnlOptimizer::MaximizeOff (   )  [virtual]

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.

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

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.

void itk::SingleValuedNonLinearVnlOptimizer::MinimizeOff (  void   )  [inline]

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0. Definition at line 78 of file itkSingleValuedNonLinearVnlOptimizer.h.

void itk::SingleValuedNonLinearVnlOptimizer::MinimizeOn (  void   )  [inline]

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0. Definition at line 76 of file itkSingleValuedNonLinearVnlOptimizer.h.

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

Print out internal state Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, and itk::LBFGSOptimizer.

virtual void itk::SingleValuedNonLinearVnlOptimizer::SetCostFunction (  SingleValuedCostFunction *  costFunction  )  [pure virtual]

Set the cost Function. This method has to be overloaded by derived classes because the CostFunctionAdaptor requires to know the number of parameters at construction time. This number of parameters is obtained at run-time from the itkCostFunction. As a consequence each derived optimizer should construct its own CostFunctionAdaptor when overloading this method Implemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer.

void itk::SingleValuedNonLinearVnlOptimizer::SetCostFunctionAdaptor (  CostFunctionAdaptorType *  adaptor  )  [protected]

virtual void itk::SingleValuedNonLinearVnlOptimizer::SetMaximize (  bool  _arg  )  [virtual]

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0.

void itk::SingleValuedNonLinearVnlOptimizer::SetMinimize (  bool  v  )  [inline]

Methods to define whether the cost function will be maximized or minimized. By default the VNL amoeba optimizer is only a minimizer. Maximization is implemented here by notifying the CostFunctionAdaptor which in its turn will multiply the function values and its derivative by -1.0. Definition at line 74 of file itkSingleValuedNonLinearVnlOptimizer.h.

---

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

• itkSingleValuedNonLinearVnlOptimizer.h

---