itk::Optimizer Class Reference
[Numerics, Optimizers]

Generic representation for an optimization method. More...

#include <itkOptimizer.h>

Inheritance diagram for itk::Optimizer:

[legend]Collaboration diagram for itk::Optimizer:

[legend]List of all members.

Public Types
typedef Optimizer	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Array< double >	ParametersType
typedef Array< double >	ScalesType
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetInitialPosition (const ParametersType &param)
virtual ParametersType	GetInitialPosition () const
void	SetScales (const ScalesType &scales)
virtual const ScalesType &	GetScales ()
virtual const ParametersType &	GetCurrentPosition ()
virtual void	StartOptimization ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	Optimizer ()
virtual	~Optimizer ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	SetCurrentPosition (const ParametersType &param)
Protected Attributes
bool	m_ScalesInitialized

---

Detailed Description

Generic representation for an optimization method.

This class is a base for a hierarchy of optimizers. It is not intended to be instantiated.

Definition at line 37 of file itkOptimizer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::NonLinearOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 44 of file itkOptimizer.h.

typedef Array<double> itk::Optimizer::ParametersType

Parameters type. It defines a position in the optimization search space. Reimplemented in itk::MultipleValuedNonLinearOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::NonLinearOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, and itk::SingleValuedNonLinearOptimizer. Definition at line 54 of file itkOptimizer.h.

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

Reimplemented from itk::Object. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::NonLinearOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 43 of file itkOptimizer.h.

typedef Array<double> itk::Optimizer::ScalesType

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 in itk::NonLinearOptimizer. Definition at line 62 of file itkOptimizer.h.

typedef Optimizer itk::Optimizer::Self

Standard class typedefs. Reimplemented from itk::Object. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::NonLinearOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 41 of file itkOptimizer.h.

typedef Object itk::Optimizer::Superclass

Reimplemented from itk::Object. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::NonLinearOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer. Definition at line 42 of file itkOptimizer.h.

---

Constructor & Destructor Documentation

itk::Optimizer::Optimizer (   )  [protected]

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

Definition at line 84 of file itkOptimizer.h.

---

Member Function Documentation

virtual const char* itk::Optimizer::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::NonLinearOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

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

Get current position of the optimization.

virtual ParametersType itk::Optimizer::GetInitialPosition (   )  const [virtual]

Get the position to initialize the optimization.

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

Get current parameters scaling.

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

Method for creation through the object factory. Reimplemented from itk::Object. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::NonLinearOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, itk::SingleValuedNonLinearOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::VersorTransformOptimizer.

void itk::Optimizer::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::Object. Reimplemented in itk::AmoebaOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::SingleValuedNonLinearOptimizer.

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

Set the current position.

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

Set the position to initialize the optimization.

void itk::Optimizer::SetScales (  const ScalesType &  scales  )

Set current parameters scaling.

virtual void itk::Optimizer::StartOptimization (  void   )  [inline, virtual]

Start optimization. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, itk::CumulativeGaussianOptimizer, itk::GradientDescentOptimizer, itk::LBFGSOptimizer, itk::LevenbergMarquardtOptimizer, itk::OnePlusOneEvolutionaryOptimizer, and itk::RegularStepGradientDescentBaseOptimizer. Definition at line 80 of file itkOptimizer.h.

---

Member Data Documentation

bool itk::Optimizer::m_ScalesInitialized [protected]

Definition at line 90 of file itkOptimizer.h.

---

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

• itkOptimizer.h

---