itk::LBFGSBOptimizerv4 Class Reference

#include <itkLBFGSBOptimizerv4.h>

Inheritance diagram for itk::LBFGSBOptimizerv4:

Collaboration diagram for itk::LBFGSBOptimizerv4:

Detailed Description

Limited memory Broyden Fletcher Goldfarb Shannon minimization with simple bounds.

This class is a wrapper for converted fortan code for performing limited memory Broyden Fletcher Goldfarb Shannon minimization with simple bounds. The algorithm miminizes a nonlinear function f(x) of n variables subject to simple bound constraints of l <= x <= u.

See also the documentation in Numerics/lbfgsb.c

References:

[1] R. H. Byrd, P. Lu and J. Nocedal. A Limited Memory Algorithm for Bound Constrained Optimization, (1995), SIAM Journal on Scientific and Statistical Computing , 16, 5, pp. 1190-1208.

[2] C. Zhu, R. H. Byrd and J. Nocedal. L-BFGS-B: Algorithm 778: L-BFGS-B, FORTRAN routines for large scale bound constrained optimization (1997), ACM Transactions on Mathematical Software, Vol 23, Num. 4, pp. 550 - 560.

Examples:

Examples/RegistrationITKv4/DeformableRegistration12.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, and Examples/RegistrationITKv4/DeformableRegistration8.cxx.

Definition at line 65 of file itkLBFGSBOptimizerv4.h.

Public Types
using	BoundSelectionType = Array< long >
enum	BoundSelectionValues {   UNBOUNDED = 0,   LOWERBOUNDED = 1,   BOTHBOUNDED = 2,   UPPERBOUNDED = 3 }
using	BoundValueType = Array< double >
using	ConstPointer = SmartPointer< const Self >
using	MetricType = Superclass::MetricType
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	ScalesType = Superclass::ScalesType
using	Self = LBFGSBOptimizerv4
using	Superclass = LBFGSOptimizerBasev4< vnl_lbfgsb >
Public Types inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgsb >
using	ConstPointer = SmartPointer< const Self >
using	InternalOptimizerType = LBFGSOptimizerBaseHelperv4< vnl_lbfgsb >
using	MetricType = Superclass::MetricType
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	ScalesType = Superclass::ScalesType
using	Self = LBFGSOptimizerBasev4
using	StopConditionDescriptionType = Superclass::StopConditionDescriptionType
using	StopConditionReturnStringType = Superclass::StopConditionReturnStringType
using	Superclass = SingleValuedNonLinearVnlOptimizerv4
Public Types inherited from itk::SingleValuedNonLinearVnlOptimizerv4
using	CommandType = ReceptorMemberCommand< Self >
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = Superclass::DerivativeType
using	MetricType = Superclass::MetricType
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	ScalesType = Superclass::ScalesType
using	Self = SingleValuedNonLinearVnlOptimizerv4
using	StopConditionDescriptionType = Superclass::StopConditionDescriptionType
using	StopConditionReturnStringType = Superclass::StopConditionReturnStringType
using	Superclass = ObjectToObjectOptimizerBase
Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = typename MetricType::DerivativeType
using	MeasureType = typename MetricType::MeasureType
using	MetricType = ObjectToObjectMetricBaseTemplate< double >
using	MetricTypePointer = typename MetricType::Pointer
using	NumberOfParametersType = typename MetricType::NumberOfParametersType
using	ParametersType = OptimizerParameters< double >
using	Pointer = SmartPointer< Self >
using	ScalesEstimatorType = OptimizerParameterScalesEstimatorTemplate< double >
using	ScalesType = OptimizerParameters< double >
using	Self = ObjectToObjectOptimizerBaseTemplate
using	StopConditionDescriptionType = std::ostringstream
using	StopConditionReturnStringType = std::string
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 BoundSelectionType &	GetBoundSelection () const
virtual double	GetCostFunctionConvergenceFactor () const
virtual const double &	GetInfinityNormOfProjectedGradient () const
ParametersType &	GetInitialPosition ()
virtual const BoundValueType &	GetLowerBound () const
virtual unsigned int	GetMaximumNumberOfCorrections () const
virtual const char *	GetNameOfClass () const
virtual const BoundValueType &	GetUpperBound () const
void	SetBoundSelection (const BoundSelectionType &select)
virtual void	SetCostFunctionConvergenceFactor (double)
void	SetInitialPosition (const ParametersType &param)
void	SetLowerBound (const BoundValueType &value)
virtual void	SetMaximumNumberOfCorrections (unsigned int)
void	SetMetric (MetricType *metric) override
void	SetScales (const ScalesType &) override
void	SetUpperBound (const BoundValueType &value)
void	StartOptimization (bool doOnlyInitialization=false) override
Public Member Functions inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgsb >
virtual double	GetGradientConvergenceTolerance () const
virtual unsigned int	GetMaximumNumberOfFunctionEvaluations () const
InternalOptimizerType *	GetOptimizer ()
const StopConditionReturnStringType	GetStopConditionDescription () const override
virtual bool	GetTrace () const
virtual void	SetGradientConvergenceTolerance (double gtol)
virtual void	SetMaximumNumberOfFunctionEvaluations (unsigned int n)
void	SetMetric (MetricType *metric) override
virtual void	SetTrace (bool flag)
void	StartOptimization (bool doOnlyInitialization=false) override
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 &	GetNumberOfWorkUnits () 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	SetNumberOfWorkUnits (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
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::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
using	InternalOptimizerType = LBFGSBOptimizerHelperv4
Protected Types inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgsb >
using	CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType
using	InternalOptimizerAutoPointer = std::unique_ptr< InternalOptimizerType >
Protected Types inherited from itk::SingleValuedNonLinearVnlOptimizerv4
using	CostFunctionAdaptorType = SingleValuedVnlCostFunctionAdaptorv4

Protected Member Functions
	LBFGSBOptimizerv4 ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~LBFGSBOptimizerv4 () override
Protected Member Functions inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgsb >
	LBFGSOptimizerBasev4 ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~LBFGSOptimizerBasev4 () override=default
Protected Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizerv4
const CostFunctionAdaptorType *	GetCostFunctionAdaptor () const
CostFunctionAdaptorType *	GetCostFunctionAdaptor ()
CostFunctionAdaptorType *	GetNonConstCostFunctionAdaptor () const
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
	SingleValuedNonLinearVnlOptimizerv4 ()
	~SingleValuedNonLinearVnlOptimizerv4 () override
Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
void	PrintSelf (std::ostream &os, Indent indent) const override
	ObjectToObjectOptimizerBaseTemplate ()
	~ObjectToObjectOptimizerBaseTemplate () override
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
BoundSelectionType	m_BoundSelection
ParametersType	m_InitialPosition
BoundValueType	m_LowerBound
unsigned int	m_MaximumNumberOfCorrections {5}
BoundValueType	m_UpperBound

Friends
class	LBFGSBOptimizerHelperv4

Additional Inherited Members
Protected Attributes inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgsb >
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_NumberOfWorkUnits
ScalesType	m_Scales
bool	m_ScalesAreIdentity
ScalesEstimatorType::Pointer	m_ScalesEstimator
ScalesType	m_Weights
bool	m_WeightsAreIdentity
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::LBFGSBOptimizerv4::BoundSelectionType = Array< long >

BoundSelection type Use for defining the boundary condition for each variables.

Definition at line 102 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::BoundValueType = Array< double >

BoundValue type. Use for defining the lower and upper bounds on the variables.

Definition at line 97 of file itkLBFGSBOptimizerv4.h.

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

Definition at line 75 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType

protected

Definition at line 166 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::InternalOptimizerType = LBFGSBOptimizerHelperv4

protected

Internal optimizer type.

Definition at line 169 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::MetricType = Superclass::MetricType

Definition at line 77 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::ParametersType = Superclass::ParametersType

Definition at line 78 of file itkLBFGSBOptimizerv4.h.

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

Definition at line 74 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::ScalesType = Superclass::ScalesType

Definition at line 79 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::Self = LBFGSBOptimizerv4

Standard "Self" type alias.

Definition at line 72 of file itkLBFGSBOptimizerv4.h.

using itk::LBFGSBOptimizerv4::Superclass = LBFGSOptimizerBasev4<vnl_lbfgsb>

Definition at line 73 of file itkLBFGSBOptimizerv4.h.

Member Enumeration Documentation

enum itk::LBFGSBOptimizerv4::BoundSelectionValues

Enumerator
UNBOUNDED
LOWERBOUNDED
BOTHBOUNDED
UPPERBOUNDED

Definition at line 87 of file itkLBFGSBOptimizerv4.h.

Constructor & Destructor Documentation

itk::LBFGSBOptimizerv4::LBFGSBOptimizerv4 ( )

protected

itk::LBFGSBOptimizerv4::~LBFGSBOptimizerv4 ( )

overrideprotected

Member Function Documentation

virtual::itk::LightObject::Pointer itk::LBFGSBOptimizerv4::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 BoundSelectionType& itk::LBFGSBOptimizerv4::GetBoundSelection ( ) const

virtual

virtual double itk::LBFGSBOptimizerv4::GetCostFunctionConvergenceFactor ( ) const

virtual

virtual const double& itk::LBFGSBOptimizerv4::GetInfinityNormOfProjectedGradient ( ) const

virtual

Get the current infinity norm of the project gradient of the cost function.

ParametersType& itk::LBFGSBOptimizerv4::GetInitialPosition ( )

inline

Get the position to initialize the optimization.

Definition at line 108 of file itkLBFGSBOptimizerv4.h.

virtual const BoundValueType& itk::LBFGSBOptimizerv4::GetLowerBound ( ) const

virtual

virtual unsigned int itk::LBFGSBOptimizerv4::GetMaximumNumberOfCorrections ( ) const

virtual

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgsb >.

virtual const BoundValueType& itk::LBFGSBOptimizerv4::GetUpperBound ( ) const

virtual

static Pointer itk::LBFGSBOptimizerv4::New ( )

static

Method for creation through the object factory.

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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

void itk::LBFGSBOptimizerv4::SetBoundSelection

(

const BoundSelectionType &

select

)

Set the boundary condition for each variable, where select[i] = 0 if x[i] is unbounded, = 1 if x[i] has only a lower bound, = 2 if x[i] has both lower and upper bounds, and = 3 if x[1] has only an upper bound

virtual void itk::LBFGSBOptimizerv4::SetCostFunctionConvergenceFactor ( double  )

virtual

Set/Get the CostFunctionConvergenceFactor. Algorithm terminates when the reduction in cost function is less than factor * epsmcj where epsmch is the machine precision. Typical values for factor: 1e+12 for low accuracy; 1e+7 for moderate accuracy and 1e+1 for extremely high accuracy.

void itk::LBFGSBOptimizerv4::SetInitialPosition

(

const ParametersType &

param

)

Set the position to initialize the optimization.

void itk::LBFGSBOptimizerv4::SetLowerBound

(

const BoundValueType &

value

)

Set the lower bound value for each variable.

virtual void itk::LBFGSBOptimizerv4::SetMaximumNumberOfCorrections ( unsigned  int )

virtual

Set/Get the MaximumNumberOfCorrections. Default is 5

void itk::LBFGSBOptimizerv4::SetMetric ( MetricType *  metric )

overridevirtual

Plug in a Cost Function into the optimizer

Implements itk::SingleValuedNonLinearVnlOptimizerv4.

void itk::LBFGSBOptimizerv4::SetScales ( const ScalesType &  )

override

This optimizer does not support scaling of the derivatives.

void itk::LBFGSBOptimizerv4::SetUpperBound

(

const BoundValueType &

value

)

Set the upper bound value for each variable.

void itk::LBFGSBOptimizerv4::StartOptimization ( bool  doOnlyInitialization = false )

overridevirtual

Start optimization with an initial value.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< double >.

Friends And Related Function Documentation

friend class LBFGSBOptimizerHelperv4

friend

Definition at line 171 of file itkLBFGSBOptimizerv4.h.

Member Data Documentation

BoundSelectionType itk::LBFGSBOptimizerv4::m_BoundSelection

private

Definition at line 179 of file itkLBFGSBOptimizerv4.h.

ParametersType itk::LBFGSBOptimizerv4::m_InitialPosition

private

Definition at line 176 of file itkLBFGSBOptimizerv4.h.

BoundValueType itk::LBFGSBOptimizerv4::m_LowerBound

private

Definition at line 177 of file itkLBFGSBOptimizerv4.h.

unsigned int itk::LBFGSBOptimizerv4::m_MaximumNumberOfCorrections {5}

private

Definition at line 174 of file itkLBFGSBOptimizerv4.h.

BoundValueType itk::LBFGSBOptimizerv4::m_UpperBound

private

Definition at line 178 of file itkLBFGSBOptimizerv4.h.

---

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

• itkLBFGSBOptimizerv4.h