Wrap of the vnl_levenberg_marquardt algorithm. More...

#include <itkLevenbergMarquardtOptimizer.h>

Inheritance diagram for itk::LevenbergMarquardtOptimizer:

Collaboration diagram for itk::LevenbergMarquardtOptimizer:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef vnl_levenberg_marquardt	InternalOptimizerType
typedef vnl_vector< double >	InternalParametersType
typedef SmartPointer< Self >	Pointer
typedef LevenbergMarquardtOptimizer	Self
typedef MultipleValuedNonLinearVnlOptimizer	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
vnl_levenberg_marquardt *	GetOptimizer (void) const
const std::string	GetStopConditionDescription () const
MeasureType	GetValue () const
virtual void	SetCostFunction (MultipleValuedCostFunction *costFunction)
void	SetEpsilonFunction (double epsilon)
void	SetGradientTolerance (double tol)
void	SetNumberOfIterations (unsigned int iterations)
void	SetValueTolerance (double tol)
void	StartOptimization (void)
Static Public Member Functions
static Pointer	New ()
Protected Types
typedef Superclass::CostFunctionAdaptorType	CostFunctionAdaptorType
Protected Member Functions
	LevenbergMarquardtOptimizer ()
virtual	~LevenbergMarquardtOptimizer ()
Private Member Functions
	LevenbergMarquardtOptimizer (const Self &)
void	operator= (const Self &)
Private Attributes
double	m_EpsilonFunction
double	m_GradientTolerance
unsigned int	m_NumberOfIterations
bool	m_OptimizerInitialized
double	m_ValueTolerance
InternalOptimizerType *	m_VnlOptimizer

Detailed Description

Wrap of the vnl_levenberg_marquardt algorithm.

Definition at line 32 of file itkLevenbergMarquardtOptimizer.h.

Member Typedef Documentation

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

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

Definition at line 40 of file itkLevenbergMarquardtOptimizer.h.

typedef Superclass::CostFunctionAdaptorType itk::LevenbergMarquardtOptimizer::CostFunctionAdaptorType [protected]

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

Definition at line 80 of file itkLevenbergMarquardtOptimizer.h.

typedef vnl_levenberg_marquardt itk::LevenbergMarquardtOptimizer::InternalOptimizerType

Internal optimizer type.

Definition at line 52 of file itkLevenbergMarquardtOptimizer.h.

typedef vnl_vector< double > itk::LevenbergMarquardtOptimizer::InternalParametersType

InternalParameters typedef.

Definition at line 46 of file itkLevenbergMarquardtOptimizer.h.

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

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

Definition at line 39 of file itkLevenbergMarquardtOptimizer.h.

typedef LevenbergMarquardtOptimizer itk::LevenbergMarquardtOptimizer::Self

Standard "Self" typedef.

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

Definition at line 37 of file itkLevenbergMarquardtOptimizer.h.

typedef MultipleValuedNonLinearVnlOptimizer itk::LevenbergMarquardtOptimizer::Superclass

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

Definition at line 38 of file itkLevenbergMarquardtOptimizer.h.

Constructor & Destructor Documentation

itk::LevenbergMarquardtOptimizer::LevenbergMarquardtOptimizer ( ) [protected]

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

itk::LevenbergMarquardtOptimizer::LevenbergMarquardtOptimizer ( const Self & ) [private]

Member Function Documentation

virtual::itk::LightObject::Pointer itk::LevenbergMarquardtOptimizer::CreateAnother ( void ) const [virtual]

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

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

Run-time type information (and related methods).

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

vnl_levenberg_marquardt* itk::LevenbergMarquardtOptimizer::GetOptimizer ( void ) const

Method for getting access to the internal optimizer.

const std::string itk::LevenbergMarquardtOptimizer::GetStopConditionDescription ( ) const [virtual]

Get the reason for termination

Reimplemented from itk::Optimizer.

MeasureType itk::LevenbergMarquardtOptimizer::GetValue ( ) const

Get the current value

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

Method for creation through the object factory.

Reimplemented from itk::MultipleValuedNonLinearOptimizer.

void itk::LevenbergMarquardtOptimizer::operator= ( const Self & ) [private]

Command observer that will interact with the ITKVNL 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

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

virtual void itk::LevenbergMarquardtOptimizer::SetCostFunction ( MultipleValuedCostFunction * costFunction ) [virtual]

Plug in a Cost Function into the optimizer

Implements itk::MultipleValuedNonLinearVnlOptimizer.

void itk::LevenbergMarquardtOptimizer::SetEpsilonFunction ( double epsilon )