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
using	ConstPointer = SmartPointer< const Self >

using	InternalOptimizerType = vnl_levenberg_marquardt

using	InternalParametersType = vnl_vector< double >

using	Pointer = SmartPointer< Self >

using	Self = LevenbergMarquardtOptimizer

using	Superclass = MultipleValuedNonLinearVnlOptimizer

Public Types inherited from itk::MultipleValuedNonLinearVnlOptimizer
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = MultipleValuedNonLinearVnlOptimizer

using	Superclass = MultipleValuedNonLinearOptimizer

Public Types inherited from itk::MultipleValuedNonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >

using	CostFunctionPointer = CostFunctionType::Pointer

using	CostFunctionType = MultipleValuedCostFunction

using	DerivativeType = Array2D< double >

using	MeasureType = Array< double >

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = MultipleValuedNonLinearOptimizer

using	Superclass = NonLinearOptimizer

Public Types inherited from itk::NonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = Superclass::ScalesType

using	Self = NonLinearOptimizer

using	Superclass = Optimizer

Public Types inherited from itk::Optimizer
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = OptimizerParameters< double >

using	Pointer = SmartPointer< Self >

using	ScalesType = Array< double >

using	Self = Optimizer

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

vnl_levenberg_marquardt *	GetOptimizer () const

const std::string	GetStopConditionDescription () const override

MeasureType	GetValue () const

void	SetCostFunction (MultipleValuedCostFunction *costFunction) override

void	SetEpsilonFunction (double epsilon)

void	SetGradientTolerance (double tol)

void	SetNumberOfIterations (unsigned int iterations)

void	SetValueTolerance (double tol)

void	StartOptimization () 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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

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
using	CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType

Protected Types inherited from itk::MultipleValuedNonLinearVnlOptimizer
using	CommandType = ReceptorMemberCommand< Self >

using	CostFunctionAdaptorType = MultipleValuedVnlCostFunctionAdaptor

Protected Member Functions
	LevenbergMarquardtOptimizer ()

	~LevenbergMarquardtOptimizer () override

Protected Member Functions inherited from itk::MultipleValuedNonLinearVnlOptimizer
const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const

CostFunctionAdaptorType *	GetCostFunctionAdaptor ()

CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const

	MultipleValuedNonLinearVnlOptimizer ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)

	~MultipleValuedNonLinearVnlOptimizer () override

Protected Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
	MultipleValuedNonLinearOptimizer ()

	~MultipleValuedNonLinearOptimizer () override=default

Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()=default

	~NonLinearOptimizer () override

Protected Member Functions inherited from itk::Optimizer
	Optimizer ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetCurrentPosition (const ParametersType &param)

	~Optimizer () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

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 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 { false }

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::LevenbergMarquardtOptimizer::ConstPointer = SmartPointer< const Self >

Definition at line 43 of file itkLevenbergMarquardtOptimizer.h.

using itk::LevenbergMarquardtOptimizer::CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType

protected

Definition at line 83 of file itkLevenbergMarquardtOptimizer.h.

using itk::LevenbergMarquardtOptimizer::InternalOptimizerType = vnl_levenberg_marquardt

Internal optimizer type.

Definition at line 55 of file itkLevenbergMarquardtOptimizer.h.

using itk::LevenbergMarquardtOptimizer::InternalParametersType = vnl_vector< double >

InternalParameters type alias.

Definition at line 52 of file itkLevenbergMarquardtOptimizer.h.

using itk::LevenbergMarquardtOptimizer::Pointer = SmartPointer< Self >

Definition at line 42 of file itkLevenbergMarquardtOptimizer.h.

using itk::LevenbergMarquardtOptimizer::Self = LevenbergMarquardtOptimizer

Standard "Self" type alias.

Definition at line 40 of file itkLevenbergMarquardtOptimizer.h.

using itk::LevenbergMarquardtOptimizer::Superclass = MultipleValuedNonLinearVnlOptimizer

Definition at line 41 of file itkLevenbergMarquardtOptimizer.h.

Constructor & Destructor Documentation

itk::LevenbergMarquardtOptimizer::LevenbergMarquardtOptimizer ( )

protected

itk::LevenbergMarquardtOptimizer::~LevenbergMarquardtOptimizer ( )

overrideprotected

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.

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

overridevirtual

Get the reason for termination

Reimplemented from itk::Optimizer.

MeasureType itk::LevenbergMarquardtOptimizer::GetValue ( ) const