itk::LBFGSOptimizerv4 Class Reference

#include <itkLBFGSOptimizerv4.h>

Inheritance diagram for itk::LBFGSOptimizerv4:

Collaboration diagram for itk::LBFGSOptimizerv4:

Detailed Description

Wrap of the vnl_lbfgs algorithm for use in ITKv4 registration framework.

Examples:

Examples/RegistrationITKv4/DeformableRegistration4.cxx, and Examples/RegistrationITKv4/DeformableRegistration6.cxx.

Definition at line 33 of file itkLBFGSOptimizerv4.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::MetricType	MetricType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef LBFGSOptimizerv4	Self
typedef LBFGSOptimizerBasev4 < vnl_lbfgs >	Superclass
Public Types inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgs >
typedef SmartPointer< const Self >	ConstPointer
typedef LBFGSOptimizerBaseHelperv4 < vnl_lbfgs >	InternalOptimizerType
typedef Superclass::MetricType	MetricType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef LBFGSOptimizerBasev4	Self
typedef Superclass::StopConditionDescriptionType	StopConditionDescriptionType
typedef Superclass::StopConditionReturnStringType	StopConditionReturnStringType
typedef SingleValuedNonLinearVnlOptimizerv4	Superclass
Public Types inherited from itk::SingleValuedNonLinearVnlOptimizerv4
typedef ReceptorMemberCommand < Self >	CommandType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::MetricType	MetricType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef SingleValuedNonLinearVnlOptimizerv4	Self
typedef Superclass::StopConditionDescriptionType	StopConditionDescriptionType
typedef Superclass::StopConditionReturnStringType	StopConditionReturnStringType
typedef ObjectToObjectOptimizerBase	Superclass
Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
typedef SmartPointer< const Self >	ConstPointer
typedef MetricType::DerivativeType	DerivativeType
typedef MetricType::MeasureType	MeasureType
typedef ObjectToObjectMetricBaseTemplate < double >	MetricType
typedef MetricType::Pointer	MetricTypePointer
typedef MetricType::NumberOfParametersType	NumberOfParametersType
typedef OptimizerParameters < double >	ParametersType
typedef SmartPointer< Self >	Pointer
typedef OptimizerParameterScalesEstimatorTemplate < double >	ScalesEstimatorType
typedef OptimizerParameters < double >	ScalesType
typedef ObjectToObjectOptimizerBaseTemplate	Self
typedef std::ostringstream	StopConditionDescriptionType
typedef std::string	StopConditionReturnStringType
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 double	GetDefaultStepLength () const
virtual double	GetLineSearchAccuracy () const
virtual const char *	GetNameOfClass () const
void	SetDefaultStepLength (double stp)
void	SetLineSearchAccuracy (double tol)
virtual void	SetMetric (MetricType *metric) override
virtual void	StartOptimization (bool doOnlyInitialization=false) override
void	VerboseOff ()
void	VerboseOn ()
Public Member Functions inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgs >
virtual double	GetGradientConvergenceTolerance () const
virtual unsigned int	GetMaximumNumberOfFunctionEvaluations () const
InternalOptimizerType *	GetOptimizer ()
virtual const StopConditionReturnStringType	GetStopConditionDescription () const override
virtual bool	GetTrace () const
virtual void	SetGradientConvergenceTolerance (double gtol)
virtual void	SetMaximumNumberOfFunctionEvaluations (unsigned int n)
virtual void	SetTrace (bool flag)
virtual void	TraceOff ()
virtual void	TraceOn ()
Public Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizerv4
virtual const DerivativeType &	GetCachedDerivative () const
virtual const ParametersType &	GetCachedCurrentPosition () const
Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
virtual SizeValueType	GetCurrentIteration () const
virtual const MeasureType &	GetCurrentMetricValue () const
virtual const ParametersType &	GetCurrentPosition () const
virtual SizeValueType	GetNumberOfIterations () const
virtual const ThreadIdType &	GetNumberOfThreads () const
virtual const ScalesType &	GetScales () const
virtual const bool &	GetScalesAreIdentity () const
bool	GetScalesInitialized () const
virtual const MeasureType &	GetValue () const
virtual const ScalesType &	GetWeights () const
virtual const bool &	GetWeightsAreIdentity () const
virtual void	SetNumberOfIterations (SizeValueType _arg)
virtual void	SetNumberOfThreads (ThreadIdType number)
virtual void	SetScalesEstimator (ScalesEstimatorType *_arg)
virtual void	SetWeights (ScalesType _arg)
virtual void	SetMetric (MetricType *_arg)
virtual MetricType *	GetModifiableMetric ()
virtual const MetricType *	GetMetric () const
virtual void	SetScales (const ScalesType &scales)
virtual void	SetDoEstimateScales (bool _arg)
virtual const bool &	GetDoEstimateScales () const
virtual void	DoEstimateScalesOn ()
virtual void	DoEstimateScalesOff ()
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::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 vnl_lbfgs	InternalOptimizerType
typedef vnl_vector< double >	InternalParametersType
Protected Types inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgs >
typedef Superclass::CostFunctionAdaptorType	CostFunctionAdaptorType
typedef AutoPointer < InternalOptimizerType >	InternalOptimizerAutoPointer
Protected Types inherited from itk::SingleValuedNonLinearVnlOptimizerv4
typedef SingleValuedVnlCostFunctionAdaptorv4	CostFunctionAdaptorType

Protected Member Functions
	LBFGSOptimizerv4 ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
virtual	~LBFGSOptimizerv4 ()
Protected Member Functions inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgs >
	LBFGSOptimizerBasev4 ()
virtual	~LBFGSOptimizerBasev4 ()
Protected Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizerv4
const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const
CostFunctionAdaptorType *	GetCostFunctionAdaptor ()
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
	SingleValuedNonLinearVnlOptimizerv4 ()
virtual	~SingleValuedNonLinearVnlOptimizerv4 ()
Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
	ObjectToObjectOptimizerBaseTemplate ()
virtual	~ObjectToObjectOptimizerBaseTemplate ()
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
	LBFGSOptimizerv4 (const Self &)
void	operator= (const Self &)

Private Attributes
double	m_DefaultStepLength
double	m_LineSearchAccuracy
bool	m_Verbose

Additional Inherited Members
Protected Attributes inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgs >
double	m_CostFunctionConvergenceFactor
double	m_GradientConvergenceTolerance
double	m_InfinityNormOfProjectedGradient
unsigned int	m_MaximumNumberOfFunctionEvaluations
bool	m_OptimizerInitialized
std::ostringstream	m_StopConditionDescription
bool	m_Trace
InternalOptimizerAutoPointer	m_VnlOptimizer
Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
SizeValueType	m_CurrentIteration
MeasureType	m_CurrentMetricValue
bool	m_DoEstimateScales
MetricTypePointer	m_Metric
SizeValueType	m_NumberOfIterations
ThreadIdType	m_NumberOfThreads
ScalesType	m_Scales
bool	m_ScalesAreIdentity
ScalesEstimatorType::Pointer	m_ScalesEstimator
ScalesType	m_Weights
bool	m_WeightsAreIdentity
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

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

Definition at line 41 of file itkLBFGSOptimizerv4.h.

typedef vnl_lbfgs itk::LBFGSOptimizerv4::InternalOptimizerType

protected

Internal optimizer type.

Definition at line 89 of file itkLBFGSOptimizerv4.h.

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

protected

InternalParameters typedef.

Definition at line 86 of file itkLBFGSOptimizerv4.h.

typedef Superclass::MetricType itk::LBFGSOptimizerv4::MetricType

Definition at line 43 of file itkLBFGSOptimizerv4.h.

typedef Superclass::ParametersType itk::LBFGSOptimizerv4::ParametersType

Definition at line 44 of file itkLBFGSOptimizerv4.h.

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

Definition at line 40 of file itkLBFGSOptimizerv4.h.

typedef Superclass::ScalesType itk::LBFGSOptimizerv4::ScalesType

Definition at line 45 of file itkLBFGSOptimizerv4.h.

typedef LBFGSOptimizerv4 itk::LBFGSOptimizerv4::Self

Standard "Self" typedef.

Definition at line 38 of file itkLBFGSOptimizerv4.h.

typedef LBFGSOptimizerBasev4<vnl_lbfgs> itk::LBFGSOptimizerv4::Superclass

Definition at line 39 of file itkLBFGSOptimizerv4.h.

Constructor & Destructor Documentation

itk::LBFGSOptimizerv4::LBFGSOptimizerv4 ( )

protected

virtual itk::LBFGSOptimizerv4::~LBFGSOptimizerv4 ( )

protectedvirtual

itk::LBFGSOptimizerv4::LBFGSOptimizerv4 ( const Self &  )

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::LBFGSOptimizerv4::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 double itk::LBFGSOptimizerv4::GetDefaultStepLength ( ) const

virtual

virtual double itk::LBFGSOptimizerv4::GetLineSearchAccuracy ( ) const

virtual

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgs >.

static Pointer itk::LBFGSOptimizerv4::New ( )

static

Method for creation through the object factory.

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

private

virtual void itk::LBFGSOptimizerv4::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Print out internal state

Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgs >.

void itk::LBFGSOptimizerv4::SetDefaultStepLength

(

double

stp

)

Set/Get the default step size. This is a positive real number with a default value of 1.0 which determines the step size in the line search.

void itk::LBFGSOptimizerv4::SetLineSearchAccuracy

(

double

tol

)

Set/Get the line search accuracy. This is a positive real number with a default value of 0.9, which controls the accuracy of the line search. If the function and gradient evalutions are inexpensive with respect to the cost of the iterations it may be advantageous to set the value to a small value (say 0.1).

virtual void itk::LBFGSOptimizerv4::SetMetric ( MetricType *  metric )

overridevirtual

Plug in a Cost Function into the optimizer

Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgs >.

virtual void itk::LBFGSOptimizerv4::StartOptimization ( bool  doOnlyInitialization = false )

overridevirtual

Start optimization with an initial value.

Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgs >.

void itk::LBFGSOptimizerv4::VerboseOff

(

)

void itk::LBFGSOptimizerv4::VerboseOn

(

)

Member Data Documentation

double itk::LBFGSOptimizerv4::m_DefaultStepLength

private

Definition at line 97 of file itkLBFGSOptimizerv4.h.

double itk::LBFGSOptimizerv4::m_LineSearchAccuracy

private

Definition at line 96 of file itkLBFGSOptimizerv4.h.

bool itk::LBFGSOptimizerv4::m_Verbose

private

Definition at line 95 of file itkLBFGSOptimizerv4.h.

---

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

• itkLBFGSOptimizerv4.h