itk::LevenbergMarquardtOptimizer Class Reference

#include <itkLevenbergMarquardtOptimizer.h>

Inheritance diagram for itk::LevenbergMarquardtOptimizer:

Collaboration diagram for itk::LevenbergMarquardtOptimizer:

Detailed Description

Wrap of the vnl_levenberg_marquardt algorithm.

Examples:

Examples/RegistrationITKv3/IterativeClosestPoint1.cxx, Examples/RegistrationITKv3/IterativeClosestPoint2.cxx, Examples/RegistrationITKv3/IterativeClosestPoint3.cxx, Examples/RegistrationITKv4/IterativeClosestPoint1.cxx, Examples/RegistrationITKv4/IterativeClosestPoint2.cxx, Examples/RegistrationITKv4/IterativeClosestPoint3.cxx, and WikiExamples/Math/LMOptimization.cxx.

Definition at line 33 of file itkLevenbergMarquardtOptimizer.h.

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 Types inherited from itk::MultipleValuedNonLinearVnlOptimizer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef MultipleValuedNonLinearVnlOptimizer	Self
typedef MultipleValuedNonLinearOptimizer	Superclass
Public Types inherited from itk::MultipleValuedNonLinearOptimizer
typedef SmartPointer< const Self >	ConstPointer
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef MultipleValuedCostFunction	CostFunctionType
typedef Array2D< double >	DerivativeType
typedef Array< double >	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef MultipleValuedNonLinearOptimizer	Self
typedef NonLinearOptimizer	Superclass
Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef NonLinearOptimizer	Self
typedef Optimizer	Superclass
Public Types inherited from itk::Optimizer
typedef SmartPointer< const Self >	ConstPointer
typedef OptimizerParameters < double >	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Array< double >	ScalesType
typedef Optimizer	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
vnl_levenberg_marquardt *	GetOptimizer () const
virtual const std::string	GetStopConditionDescription () const override
MeasureType	GetValue () const
virtual void	SetCostFunction (MultipleValuedCostFunction *costFunction) override
void	SetEpsilonFunction (double epsilon)
void	SetGradientTolerance (double tol)
void	SetNumberOfIterations (unsigned int iterations)
void	SetValueTolerance (double tol)
virtual void	StartOptimization (void) override
Public Member Functions inherited from itk::MultipleValuedNonLinearVnlOptimizer
bool	GetUseCostFunctionGradient () const
void	SetUseCostFunctionGradient (bool)
void	UseCostFunctionGradientOff ()
void	UseCostFunctionGradientOn ()
virtual const MeasureType &	GetCachedValue () const
virtual const DerivativeType &	GetCachedDerivative () const
virtual const ParametersType &	GetCachedCurrentPosition () const
Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual void	SetCostFunction (CostFunctionType *costFunction)
Public Member Functions inherited from itk::NonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
Public Member Functions inherited from itk::Optimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const ParametersType &	GetCurrentPosition () const
virtual const ParametersType &	GetInitialPosition () const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetScales (const ScalesType &scales)
virtual const ScalesType &	GetScales () const
virtual const ScalesType &	GetInverseScales () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
static Pointer	New ()
Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer	New ()
Static Public Member Functions inherited from itk::Optimizer
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Types
typedef Superclass::CostFunctionAdaptorType	CostFunctionAdaptorType
Protected Types inherited from itk::MultipleValuedNonLinearVnlOptimizer
typedef ReceptorMemberCommand < Self >	CommandType
typedef MultipleValuedVnlCostFunctionAdaptor	CostFunctionAdaptorType

Protected Member Functions
	LevenbergMarquardtOptimizer ()
virtual	~LevenbergMarquardtOptimizer ()
Protected Member Functions inherited from itk::MultipleValuedNonLinearVnlOptimizer
const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const
CostFunctionAdaptorType *	GetCostFunctionAdaptor ()
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const
	MultipleValuedNonLinearVnlOptimizer ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
virtual	~MultipleValuedNonLinearVnlOptimizer ()
Protected Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
	MultipleValuedNonLinearOptimizer ()
virtual	~MultipleValuedNonLinearOptimizer ()
Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()
virtual	~NonLinearOptimizer ()
Protected Member Functions inherited from itk::Optimizer
	Optimizer ()
virtual void	SetCurrentPosition (const ParametersType &param)
virtual	~Optimizer ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
	LevenbergMarquardtOptimizer (const Self &) ITK_DELETE_FUNCTION
void	operator= (const Self &) ITK_DELETE_FUNCTION

Private Attributes
double	m_EpsilonFunction
double	m_GradientTolerance
unsigned int	m_NumberOfIterations
bool	m_OptimizerInitialized
double	m_ValueTolerance
InternalOptimizerType *	m_VnlOptimizer

Additional Inherited Members
Protected Attributes inherited from itk::MultipleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction
Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition
bool	m_ScalesInitialized
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

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

Definition at line 41 of file itkLevenbergMarquardtOptimizer.h.

typedef Superclass::CostFunctionAdaptorType itk::LevenbergMarquardtOptimizer::CostFunctionAdaptorType

protected

Definition at line 81 of file itkLevenbergMarquardtOptimizer.h.

typedef vnl_levenberg_marquardt itk::LevenbergMarquardtOptimizer::InternalOptimizerType

Internal optimizer type.

Definition at line 53 of file itkLevenbergMarquardtOptimizer.h.

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

InternalParameters typedef.

Definition at line 47 of file itkLevenbergMarquardtOptimizer.h.

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

Definition at line 40 of file itkLevenbergMarquardtOptimizer.h.

typedef LevenbergMarquardtOptimizer itk::LevenbergMarquardtOptimizer::Self

Standard "Self" typedef.

Definition at line 38 of file itkLevenbergMarquardtOptimizer.h.

typedef MultipleValuedNonLinearVnlOptimizer itk::LevenbergMarquardtOptimizer::Superclass

Definition at line 39 of file itkLevenbergMarquardtOptimizer.h.

Constructor & Destructor Documentation

itk::LevenbergMarquardtOptimizer::LevenbergMarquardtOptimizer ( )

protected

virtual itk::LevenbergMarquardtOptimizer::~LevenbergMarquardtOptimizer ( )

protectedvirtual

itk::LevenbergMarquardtOptimizer::LevenbergMarquardtOptimizer ( const Self &  )

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::LevenbergMarquardtOptimizer::CreateAnother ( ) 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::Object.

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

(

)

const

Method for getting access to the internal optimizer.

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

overridevirtual

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.

void itk::LevenbergMarquardtOptimizer::operator= ( const Self &  )

private

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

overridevirtual

Plug in a Cost Function into the optimizer

Implements itk::MultipleValuedNonLinearVnlOptimizer.

void itk::LevenbergMarquardtOptimizer::SetEpsilonFunction

(

double

epsilon

)

void itk::LevenbergMarquardtOptimizer::SetGradientTolerance

(

double

tol

)

void itk::LevenbergMarquardtOptimizer::SetNumberOfIterations

(

unsigned int

iterations

)

void itk::LevenbergMarquardtOptimizer::SetValueTolerance

(

double

tol

)

virtual void itk::LevenbergMarquardtOptimizer::StartOptimization ( void  )

overridevirtual

Start optimization with an initial value.

Reimplemented from itk::Optimizer.

Member Data Documentation

double itk::LevenbergMarquardtOptimizer::m_EpsilonFunction

private

Definition at line 92 of file itkLevenbergMarquardtOptimizer.h.

double itk::LevenbergMarquardtOptimizer::m_GradientTolerance

private

Definition at line 91 of file itkLevenbergMarquardtOptimizer.h.

unsigned int itk::LevenbergMarquardtOptimizer::m_NumberOfIterations

private

Definition at line 89 of file itkLevenbergMarquardtOptimizer.h.

bool itk::LevenbergMarquardtOptimizer::m_OptimizerInitialized

private

Definition at line 87 of file itkLevenbergMarquardtOptimizer.h.

double itk::LevenbergMarquardtOptimizer::m_ValueTolerance

private

Definition at line 90 of file itkLevenbergMarquardtOptimizer.h.

InternalOptimizerType* itk::LevenbergMarquardtOptimizer::m_VnlOptimizer

private

Definition at line 88 of file itkLevenbergMarquardtOptimizer.h.

---

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

• itkLevenbergMarquardtOptimizer.h