itk::LevenbergMarquardtOptimizer Class Reference

#include <itkLevenbergMarquardtOptimizer.h>

Inheritance diagram for itk::LevenbergMarquardtOptimizer:

Collaboration diagram for itk::LevenbergMarquardtOptimizer:

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 &	GetInitialPosition () const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetScales (const ScalesType &scales)
virtual const ScalesType &	GetScales () const
virtual const ScalesType &	GetInverseScales () const
virtual const ParametersType &	GetCurrentPosition () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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 noexcept override
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
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
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 val)
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	CostFunctionAdaptorType = MultipleValuedVnlCostFunctionAdaptor
using	CommandType = ReceptorMemberCommand< Self >

Protected Member Functions
	LevenbergMarquardtOptimizer ()
	~LevenbergMarquardtOptimizer () override
Protected Member Functions inherited from itk::MultipleValuedNonLinearVnlOptimizer
	MultipleValuedNonLinearVnlOptimizer ()
	~MultipleValuedNonLinearVnlOptimizer () override
void	PrintSelf (std::ostream &os, Indent indent) const override
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const
CostFunctionAdaptorType *	GetCostFunctionAdaptor ()
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const
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 ()
	~Optimizer () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetCurrentPosition (const ParametersType &param)
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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
bool	m_ScalesInitialized { false }
ParametersType	m_CurrentPosition
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

Wrap of the vnl_levenberg_marquardt algorithm.

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Levenberg-Marquardt Optimiztion

Examples

Examples/RegistrationITKv4/IterativeClosestPoint1.cxx, Examples/RegistrationITKv4/IterativeClosestPoint2.cxx, Examples/RegistrationITKv4/IterativeClosestPoint3.cxx, and SphinxExamples/src/Numerics/Optimizers/LevenbergMarquardtOptimization/Code.cxx.

Definition at line 37 of file itkLevenbergMarquardtOptimizer.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 46 of file itkLevenbergMarquardtOptimizer.h.

CostFunctionAdaptorType

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

protected

Definition at line 95 of file itkLevenbergMarquardtOptimizer.h.

InternalOptimizerType

using itk::LevenbergMarquardtOptimizer::InternalOptimizerType = vnl_levenberg_marquardt

Internal optimizer type.

Definition at line 58 of file itkLevenbergMarquardtOptimizer.h.

InternalParametersType

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

InternalParameters type alias.

Definition at line 55 of file itkLevenbergMarquardtOptimizer.h.

Pointer

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

Definition at line 45 of file itkLevenbergMarquardtOptimizer.h.

Self

using itk::LevenbergMarquardtOptimizer::Self = LevenbergMarquardtOptimizer

Standard "Self" type alias.

Definition at line 43 of file itkLevenbergMarquardtOptimizer.h.

Superclass

using itk::LevenbergMarquardtOptimizer::Superclass = MultipleValuedNonLinearVnlOptimizer

Definition at line 44 of file itkLevenbergMarquardtOptimizer.h.

Constructor & Destructor Documentation

LevenbergMarquardtOptimizer()

itk::LevenbergMarquardtOptimizer::LevenbergMarquardtOptimizer ( )

protected

~LevenbergMarquardtOptimizer()

itk::LevenbergMarquardtOptimizer::~LevenbergMarquardtOptimizer ( )

overrideprotected

Member Function Documentation

CreateAnother()

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.

GetNameOfClass()

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::MultipleValuedNonLinearVnlOptimizer.

GetOptimizer()

vnl_levenberg_marquardt* itk::LevenbergMarquardtOptimizer::GetOptimizer

(

)

const

Method for getting access to the internal optimizer.

GetStopConditionDescription()

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

overridevirtual

Get the reason for termination

Reimplemented from itk::Optimizer.

GetValue()

MeasureType itk::LevenbergMarquardtOptimizer::GetValue

(

)

const

Get the current value

New()

static Pointer itk::LevenbergMarquardtOptimizer::New ( )

static

Method for creation through the object factory.

SetCostFunction()

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

overridevirtual

Plug in a Cost Function into the optimizer

Implements itk::MultipleValuedNonLinearVnlOptimizer.

SetEpsilonFunction()

void itk::LevenbergMarquardtOptimizer::SetEpsilonFunction

(

double

epsilon

)

SetGradientTolerance()

void itk::LevenbergMarquardtOptimizer::SetGradientTolerance

(

double

tol

)

SetNumberOfIterations()

void itk::LevenbergMarquardtOptimizer::SetNumberOfIterations

(

unsigned int

iterations

)

SetValueTolerance()

void itk::LevenbergMarquardtOptimizer::SetValueTolerance

(

double

tol

)

StartOptimization()

void itk::LevenbergMarquardtOptimizer::StartOptimization ( )

overridevirtual

Start optimization with an initial value.

Reimplemented from itk::Optimizer.

Member Data Documentation

m_EpsilonFunction

double itk::LevenbergMarquardtOptimizer::m_EpsilonFunction

private

Definition at line 103 of file itkLevenbergMarquardtOptimizer.h.

m_GradientTolerance

double itk::LevenbergMarquardtOptimizer::m_GradientTolerance

private

Definition at line 102 of file itkLevenbergMarquardtOptimizer.h.

m_NumberOfIterations

unsigned int itk::LevenbergMarquardtOptimizer::m_NumberOfIterations

private

Definition at line 100 of file itkLevenbergMarquardtOptimizer.h.

m_OptimizerInitialized

bool itk::LevenbergMarquardtOptimizer::m_OptimizerInitialized

private

Definition at line 98 of file itkLevenbergMarquardtOptimizer.h.

m_ValueTolerance

double itk::LevenbergMarquardtOptimizer::m_ValueTolerance

private

Definition at line 101 of file itkLevenbergMarquardtOptimizer.h.

m_VnlOptimizer

InternalOptimizerType* itk::LevenbergMarquardtOptimizer::m_VnlOptimizer

private

Definition at line 99 of file itkLevenbergMarquardtOptimizer.h.

---

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

• itkLevenbergMarquardtOptimizer.h