itk::MultipleValuedNonLinearVnlOptimizer Class Reference
[Numerics, Optimizers]

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

#include <itkMultipleValuedNonLinearVnlOptimizer.h>

Inheritance diagram for itk::MultipleValuedNonLinearVnlOptimizer:

[legend]Collaboration diagram for itk::MultipleValuedNonLinearVnlOptimizer:

[legend]List of all members.

Public Types
typedef MultipleValuedNonLinearVnlOptimizer	Self
typedef MultipleValuedNonLinearOptimizer	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetCostFunction (MultipleValuedCostFunction *costFunction)=0
void	SetUseCostFunctionGradient (bool)
void	UseCostFunctionGradientOn ()
void	UseCostFunctionGradientOff ()
bool	GetUseCostFunctionGradient () const
Protected Types
typedef MultipleValuedVnlCostFunctionAdaptor	CostFunctionAdaptorType
Protected Member Functions
	MultipleValuedNonLinearVnlOptimizer ()
virtual	~MultipleValuedNonLinearVnlOptimizer ()
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
const CostFunctionAdaptorType *	GetCostFunctionAdaptor (void) const
CostFunctionAdaptorType *	GetCostFunctionAdaptor (void)
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor (void) const

---

Detailed Description

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

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

Definition at line 35 of file itkMultipleValuedNonLinearVnlOptimizer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 43 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef MultipleValuedVnlCostFunctionAdaptor itk::MultipleValuedNonLinearVnlOptimizer::CostFunctionAdaptorType [protected]

Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 75 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef Superclass::ParametersType itk::MultipleValuedNonLinearVnlOptimizer::ParametersType

ParametersType typedef. It defines a position in the optimization search space. Reimplemented from itk::MultipleValuedNonLinearOptimizer. Definition at line 52 of file itkMultipleValuedNonLinearVnlOptimizer.h.

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

Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 42 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef MultipleValuedNonLinearVnlOptimizer itk::MultipleValuedNonLinearVnlOptimizer::Self

Standard class typedefs. Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 40 of file itkMultipleValuedNonLinearVnlOptimizer.h.

typedef MultipleValuedNonLinearOptimizer itk::MultipleValuedNonLinearVnlOptimizer::Superclass

Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer. Definition at line 41 of file itkMultipleValuedNonLinearVnlOptimizer.h.

---

Constructor & Destructor Documentation

itk::MultipleValuedNonLinearVnlOptimizer::MultipleValuedNonLinearVnlOptimizer (   )  [protected]

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

---

Member Function Documentation

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

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

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

Run-time type information (and related methods). Reimplemented from itk::MultipleValuedNonLinearOptimizer. Reimplemented in itk::LevenbergMarquardtOptimizer.

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

The purpose of this method is to get around the lack of const correctness in vnl cost_functions and optimizers

bool itk::MultipleValuedNonLinearVnlOptimizer::GetUseCostFunctionGradient (   )  const

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach

virtual void itk::MultipleValuedNonLinearVnlOptimizer::SetCostFunction (  MultipleValuedCostFunction *  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::LevenbergMarquardtOptimizer.

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

void itk::MultipleValuedNonLinearVnlOptimizer::SetUseCostFunctionGradient (  bool   )

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOff (   )  [inline]

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach Definition at line 67 of file itkMultipleValuedNonLinearVnlOptimizer.h.

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOn (   )  [inline]

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach Definition at line 66 of file itkMultipleValuedNonLinearVnlOptimizer.h.

---

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

• itkMultipleValuedNonLinearVnlOptimizer.h

---