ITK 6.0.0
Insight Toolkit
 
Loading...
Searching...
No Matches
itk::LBFGSBOptimizerv4 Class Reference

#include <itkLBFGSBOptimizerv4.h>

Detailed Description

Limited memory Broyden Fletcher Goldfarb Shannon minimization with simple bounds.

This class is a wrapper for converted Fortran code for performing limited memory Broyden Fletcher Goldfarb Shannon minimization with simple bounds. The algorithm minimizes 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

For algorithmic details see [18] and [147].

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

Definition at line 56 of file itkLBFGSBOptimizerv4.h.

+ Inheritance diagram for itk::LBFGSBOptimizerv4:
+ Collaboration diagram for itk::LBFGSBOptimizerv4:

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
 
using ConstPointer
 
using InternalOptimizerType
 
using InternalOptimizerType
 
using MetricType
 
using MetricType
 
using ParametersType
 
using ParametersType
 
using Pointer
 
using Pointer
 
using ScalesType
 
using ScalesType
 
using Self
 
using Self
 
using StopConditionDescriptionType
 
using StopConditionDescriptionType
 
using StopConditionReturnStringType
 
using StopConditionReturnStringType
 
using Superclass
 
using Superclass
 
- 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
 
using DerivativeType
 
using MeasureType
 
using MetricType
 
using MetricTypePointer
 
using NumberOfParametersType
 
using ParametersType
 
using Pointer
 
using ScalesEstimatorType
 
using ScalesType
 
using Self
 
using StopConditionDescriptionType
 
using StopConditionReturnStringType
 
using Superclass
 
- 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

bool CanUseScales () const override
 
virtual::itk::LightObject::Pointer CreateAnother () const
 
virtual const BoundSelectionTypeGetBoundSelection () const
 
virtual double GetCostFunctionConvergenceFactor () const
 
virtual const double & GetInfinityNormOfProjectedGradient () const
 
ParametersTypeGetInitialPosition ()
 
virtual const BoundValueTypeGetLowerBound () const
 
virtual unsigned int GetMaximumNumberOfCorrections () const
 
const char * GetNameOfClass () const override
 
virtual const BoundValueTypeGetUpperBound () const
 
void SetBoundSelection (const BoundSelectionType &value)
 
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 double GetGradientConvergenceTolerance () const
 
virtual unsigned int GetMaximumNumberOfFunctionEvaluations () const
 
virtual unsigned int GetMaximumNumberOfFunctionEvaluations () const
 
const char * GetNameOfClass () const override
 
const char * GetNameOfClass () const override
 
InternalOptimizerTypeGetOptimizer ()
 
InternalOptimizerTypeGetOptimizer ()
 
StopConditionReturnStringType GetStopConditionDescription () const override
 
StopConditionReturnStringType GetStopConditionDescription () const override
 
virtual bool GetTrace () const
 
virtual bool GetTrace () const
 
virtual void SetGradientConvergenceTolerance (double f)
 
virtual void SetGradientConvergenceTolerance (double f)
 
virtual void SetMaximumNumberOfFunctionEvaluations (unsigned int n)
 
virtual void SetMaximumNumberOfFunctionEvaluations (unsigned int n)
 
void SetMetric (MetricType *metric) override
 
void SetMetric (MetricType *metric) override
 
virtual void SetTrace (bool flag)
 
virtual void SetTrace (bool flag)
 
void StartOptimization (bool doOnlyInitialization=false) override
 
void StartOptimization (bool doOnlyInitialization=false) override
 
virtual void TraceOff ()
 
virtual void TraceOff ()
 
virtual void TraceOn ()
 
virtual void TraceOn ()
 
- Public Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizerv4
const char * GetNameOfClass () const override
 
void StartOptimization (bool doOnlyInitialization=false) override
 
virtual const DerivativeTypeGetCachedDerivative () const
 
virtual const ParametersTypeGetCachedCurrentPosition () const
 
- Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
virtual SizeValueType GetCurrentIteration () const
 
virtual SizeValueType GetCurrentIteration () const
 
virtual const MeasureTypeGetCurrentMetricValue () const
 
virtual const MeasureTypeGetCurrentMetricValue () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
virtual SizeValueType GetNumberOfIterations () const
 
virtual SizeValueType GetNumberOfIterations () const
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetScales () const
 
virtual const bool & GetScalesAreIdentity () const
 
virtual const bool & GetScalesAreIdentity () const
 
bool GetScalesInitialized () const
 
bool GetScalesInitialized () const
 
virtual const MeasureTypeGetValue () const
 
virtual const MeasureTypeGetValue () const
 
virtual const ScalesTypeGetWeights () const
 
virtual const ScalesTypeGetWeights () const
 
virtual const bool & GetWeightsAreIdentity () const
 
virtual const bool & GetWeightsAreIdentity () const
 
virtual void SetNumberOfIterations (SizeValueType _arg)
 
virtual void SetNumberOfIterations (SizeValueType _arg)
 
virtual void SetNumberOfWorkUnits (ThreadIdType number)
 
virtual void SetNumberOfWorkUnits (ThreadIdType number)
 
virtual void SetScalesEstimator (ScalesEstimatorType *_arg)
 
virtual void SetScalesEstimator (ScalesEstimatorType *_arg)
 
virtual void SetWeights (ScalesType _arg)
 
virtual void SetWeights (ScalesType _arg)
 
virtual MetricTypeGetModifiableMetric ()
 
virtual const MetricTypeGetMetric () const
 
virtual MetricTypeGetModifiableMetric ()
 
virtual const MetricTypeGetMetric () const
 
virtual void SetDoEstimateScales (bool _arg)
 
virtual const bool & GetDoEstimateScales () const
 
virtual void DoEstimateScalesOn ()
 
virtual void DoEstimateScalesOff ()
 
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 *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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) const
 
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::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
 
using InternalOptimizerType = LBFGSBOptimizerHelperv4
 
- Protected Types inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgsb >
using CostFunctionAdaptorType
 
using CostFunctionAdaptorType
 
using InternalOptimizerAutoPointer
 
using InternalOptimizerAutoPointer
 
- 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 ()
 
 LBFGSOptimizerBasev4 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~LBFGSOptimizerBasev4 () override=default
 
 ~LBFGSOptimizerBasev4 () override=default
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizerv4
CostFunctionAdaptorTypeGetCostFunctionAdaptor ()
 
const CostFunctionAdaptorTypeGetCostFunctionAdaptor () const
 
CostFunctionAdaptorTypeGetNonConstCostFunctionAdaptor () const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
 
 SingleValuedNonLinearVnlOptimizerv4 ()
 
 ~SingleValuedNonLinearVnlOptimizerv4 () override
 
- Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
 ObjectToObjectOptimizerBaseTemplate ()
 
 ObjectToObjectOptimizerBaseTemplate ()
 
 ~ObjectToObjectOptimizerBaseTemplate () override
 
 ~ObjectToObjectOptimizerBaseTemplate () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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_CostFunctionConvergenceFactor
 
double m_GradientConvergenceTolerance
 
double m_GradientConvergenceTolerance
 
double m_InfinityNormOfProjectedGradient
 
double m_InfinityNormOfProjectedGradient
 
unsigned int m_MaximumNumberOfFunctionEvaluations
 
unsigned int m_MaximumNumberOfFunctionEvaluations
 
bool m_OptimizerInitialized
 
bool m_OptimizerInitialized
 
std::ostringstream m_StopConditionDescription
 
std::ostringstream m_StopConditionDescription
 
bool m_Trace
 
bool m_Trace
 
InternalOptimizerAutoPointer m_VnlOptimizer
 
InternalOptimizerAutoPointer m_VnlOptimizer
 
- Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
SizeValueType m_CurrentIteration
 
SizeValueType m_CurrentIteration
 
MeasureType m_CurrentMetricValue
 
MeasureType m_CurrentMetricValue
 
bool m_DoEstimateScales
 
bool m_DoEstimateScales
 
MetricTypePointer m_Metric
 
MetricTypePointer m_Metric
 
SizeValueType m_NumberOfIterations
 
SizeValueType m_NumberOfIterations
 
ThreadIdType m_NumberOfWorkUnits
 
ThreadIdType m_NumberOfWorkUnits
 
ScalesType m_Scales
 
ScalesType m_Scales
 
bool m_ScalesAreIdentity
 
bool m_ScalesAreIdentity
 
ScalesEstimatorType::Pointer m_ScalesEstimator
 
ScalesEstimatorType::Pointer m_ScalesEstimator
 
ScalesType m_Weights
 
ScalesType m_Weights
 
bool m_WeightsAreIdentity
 
bool m_WeightsAreIdentity
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ BoundSelectionType

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

Definition at line 93 of file itkLBFGSBOptimizerv4.h.

◆ BoundValueType

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

Definition at line 88 of file itkLBFGSBOptimizerv4.h.

◆ ConstPointer

◆ CostFunctionAdaptorType

◆ InternalOptimizerType

Internal optimizer type.

Definition at line 178 of file itkLBFGSBOptimizerv4.h.

◆ MetricType

◆ ParametersType

◆ Pointer

◆ ScalesType

◆ Self

Standard "Self" type alias.

Definition at line 62 of file itkLBFGSBOptimizerv4.h.

◆ Superclass

Definition at line 63 of file itkLBFGSBOptimizerv4.h.

Member Enumeration Documentation

◆ BoundSelectionValues

Enumerator
UNBOUNDED 
LOWERBOUNDED 
BOTHBOUNDED 
UPPERBOUNDED 

Definition at line 77 of file itkLBFGSBOptimizerv4.h.

Constructor & Destructor Documentation

◆ LBFGSBOptimizerv4()

itk::LBFGSBOptimizerv4::LBFGSBOptimizerv4 ( )
protected

Referenced by GetNameOfClass().

◆ ~LBFGSBOptimizerv4()

itk::LBFGSBOptimizerv4::~LBFGSBOptimizerv4 ( )
overrideprotected

Member Function Documentation

◆ CanUseScales()

bool itk::LBFGSBOptimizerv4::CanUseScales ( ) const
inlineoverridevirtual

Returns false unconditionally because LBFGSBOptimizerv4 does not support using scales.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< double >.

Definition at line 164 of file itkLBFGSBOptimizerv4.h.

◆ CreateAnother()

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::LightObject.

◆ GetBoundSelection()

virtual const BoundSelectionType & itk::LBFGSBOptimizerv4::GetBoundSelection ( ) const
virtual

◆ GetCostFunctionConvergenceFactor()

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

◆ GetInfinityNormOfProjectedGradient()

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

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

◆ GetInitialPosition()

ParametersType & itk::LBFGSBOptimizerv4::GetInitialPosition ( )
inline

Get the position to initialize the optimization.

Definition at line 101 of file itkLBFGSBOptimizerv4.h.

References m_InitialPosition.

◆ GetLowerBound()

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

◆ GetMaximumNumberOfCorrections()

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

◆ GetNameOfClass()

const char * itk::LBFGSBOptimizerv4::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References LBFGSBOptimizerv4().

◆ GetUpperBound()

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

◆ New()

static Pointer itk::LBFGSBOptimizerv4::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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::LightObject.

◆ SetBoundSelection()

void itk::LBFGSBOptimizerv4::SetBoundSelection ( const BoundSelectionType & value)

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

◆ SetCostFunctionConvergenceFactor()

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.

◆ SetInitialPosition()

void itk::LBFGSBOptimizerv4::SetInitialPosition ( const ParametersType & param)

Set the position to initialize the optimization.

◆ SetLowerBound()

void itk::LBFGSBOptimizerv4::SetLowerBound ( const BoundValueType & value)

Set the lower bound value for each variable.

◆ SetMaximumNumberOfCorrections()

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

Set/Get the MaximumNumberOfCorrections. Default is 5

◆ SetMetric()

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

Plug in a Cost Function into the optimizer

Implements itk::SingleValuedNonLinearVnlOptimizerv4.

◆ SetScales()

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

This optimizer does not support scaling of the derivatives.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< double >.

◆ SetUpperBound()

void itk::LBFGSBOptimizerv4::SetUpperBound ( const BoundValueType & value)

Set the upper bound value for each variable.

◆ StartOptimization()

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

Start optimization with an initial value.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< double >.

Friends And Related Symbol Documentation

◆ LBFGSBOptimizerHelperv4

friend class LBFGSBOptimizerHelperv4
friend

Definition at line 180 of file itkLBFGSBOptimizerv4.h.

References LBFGSBOptimizerHelperv4.

Referenced by LBFGSBOptimizerHelperv4.

Member Data Documentation

◆ m_BoundSelection

BoundSelectionType itk::LBFGSBOptimizerv4::m_BoundSelection {}
private

Definition at line 188 of file itkLBFGSBOptimizerv4.h.

◆ m_InitialPosition

ParametersType itk::LBFGSBOptimizerv4::m_InitialPosition {}
private

Definition at line 185 of file itkLBFGSBOptimizerv4.h.

Referenced by GetInitialPosition().

◆ m_LowerBound

BoundValueType itk::LBFGSBOptimizerv4::m_LowerBound {}
private

Definition at line 186 of file itkLBFGSBOptimizerv4.h.

◆ m_MaximumNumberOfCorrections

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

Definition at line 183 of file itkLBFGSBOptimizerv4.h.

◆ m_UpperBound

BoundValueType itk::LBFGSBOptimizerv4::m_UpperBound {}
private

Definition at line 187 of file itkLBFGSBOptimizerv4.h.


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