ITK
5.2.0
Insight Toolkit
|
#include <itkLBFGSBOptimizer.h>
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const char * | GetNameOfClass () const |
virtual bool | GetTrace () |
void | SetCostFunction (SingleValuedCostFunction *costFunction) override |
virtual void | SetTrace (bool flag) |
void | StartOptimization () override |
virtual void | TraceOff () |
virtual void | TraceOn () |
Public Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizer | |
virtual const bool & | GetMaximize () const |
virtual void | SetMaximize (bool _arg) |
virtual void | MaximizeOn () |
virtual void | MaximizeOff () |
bool | GetMinimize () const |
void | SetMinimize (bool v) |
void | MinimizeOn () |
void | MinimizeOff () |
virtual const MeasureType & | GetCachedValue () const |
virtual const DerivativeType & | GetCachedDerivative () const |
virtual const ParametersType & | GetCachedCurrentPosition () const |
Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const CostFunctionType * | GetCostFunction () const |
virtual CostFunctionType * | GetModifiableCostFunction () |
MeasureType | GetValue (const ParametersType ¶meters) const |
virtual void | SetCostFunction (CostFunctionType *costFunction) |
Public Member Functions inherited from itk::Optimizer | |
virtual const ParametersType & | GetInitialPosition () const |
virtual void | SetInitialPosition (const ParametersType ¶m) |
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::SingleValuedNonLinearOptimizer | |
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 () |
using | CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType |
class | LBFGSBOptimizerHelper |
bool | m_Trace { false } |
bool | m_OptimizerInitialized { false } |
double | m_CostFunctionConvergenceFactor { 1e+7 } |
double | m_ProjectedGradientTolerance { 1e-5 } |
unsigned int | m_MaximumNumberOfIterations { 500 } |
unsigned int | m_MaximumNumberOfEvaluations { 500 } |
unsigned int | m_MaximumNumberOfCorrections { 5 } |
unsigned int | m_CurrentIteration { 0 } |
double | m_InfinityNormOfProjectedGradient { 0.0 } |
InternalOptimizerType * | m_VnlOptimizer { nullptr } |
BoundValueType | m_LowerBound |
BoundValueType | m_UpperBound |
BoundSelectionType | m_BoundSelection |
virtual void | SetLowerBound (const BoundValueType &value) |
virtual const BoundValueType & | GetLowerBound () const |
virtual void | SetUpperBound (const BoundValueType &value) |
virtual const BoundValueType & | GetUpperBound () const |
virtual void | SetBoundSelection (const BoundSelectionType &value) |
virtual const BoundSelectionType & | GetBoundSelection () const |
virtual void | SetCostFunctionConvergenceFactor (double) |
virtual double | GetCostFunctionConvergenceFactor () |
virtual void | SetProjectedGradientTolerance (double) |
virtual double | GetProjectedGradientTolerance () |
virtual void | SetMaximumNumberOfIterations (unsigned int) |
virtual unsigned int | GetMaximumNumberOfIterations () |
virtual void | SetMaximumNumberOfEvaluations (unsigned int) |
virtual unsigned int | GetMaximumNumberOfEvaluations () |
virtual void | SetMaximumNumberOfCorrections (unsigned int) |
virtual unsigned int | GetMaximumNumberOfCorrections () |
void | SetScales (const ScalesType &) |
virtual const unsigned int & | GetCurrentIteration () const |
MeasureType | GetValue () const |
virtual const double & | GetInfinityNormOfProjectedGradient () const |
const std::string | GetStopConditionDescription () const override |
LBFGSBOptimizer () | |
~LBFGSBOptimizer () override | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
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 mininizes 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.
Definition at line 63 of file itkLBFGSBOptimizer.h.
using itk::LBFGSBOptimizer::BoundSelectionType = Array<long> |
BoundSelection type Use for defining the boundary condition for each variables.
Definition at line 88 of file itkLBFGSBOptimizer.h.
using itk::LBFGSBOptimizer::BoundValueType = Array<double> |
BoundValue type. Use for defining the lower and upper bounds on the variables.
Definition at line 83 of file itkLBFGSBOptimizer.h.
using itk::LBFGSBOptimizer::ConstPointer = SmartPointer<const Self> |
Definition at line 72 of file itkLBFGSBOptimizer.h.
|
protected |
Set the lower bound value for each variable.
Definition at line 205 of file itkLBFGSBOptimizer.h.
using itk::LBFGSBOptimizer::InternalBoundSelectionType = vnl_vector<long> |
Internal boundary selection storage type
Definition at line 94 of file itkLBFGSBOptimizer.h.
using itk::LBFGSBOptimizer::InternalBoundValueType = vnl_vector<double> |
Internal boundary value storage type
Definition at line 91 of file itkLBFGSBOptimizer.h.
The vnl optimizer
Definition at line 97 of file itkLBFGSBOptimizer.h.
Definition at line 71 of file itkLBFGSBOptimizer.h.
Standard "Self" type alias.
Definition at line 69 of file itkLBFGSBOptimizer.h.
Definition at line 70 of file itkLBFGSBOptimizer.h.
|
protected |
Set the lower bound value for each variable.
|
overrideprotected |
Set the lower bound value for each variable.
|
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 |
Set the lower bound value for each variable.
|
virtual |
Set the lower bound value for each variable.
|
virtual |
Get the current iteration number.
|
virtual |
Get the current infinity norm of the project gradient of the cost function.
|
virtual |
Set the lower bound value for each variable.
|
virtual |
Set the lower bound value for each variable.
|
virtual |
Set the lower bound value for each variable.
|
virtual |
Set the lower bound value for each variable.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.
|
virtual |
Set the lower bound value for each variable.
|
overridevirtual |
Get the reason for termination
Reimplemented from itk::Optimizer.
|
virtual |
|
virtual |
Set the lower bound value for each variable.
MeasureType itk::LBFGSBOptimizer::GetValue | ( | ) | const |
Get the current cost function value.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Set the lower bound value for each variable.
Reimplemented from itk::Object.
|
virtual |
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
|
overridevirtual |
Plug in a Cost Function into the optimizer
Implements itk::SingleValuedNonLinearVnlOptimizer.
|
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.
|
virtual |
Set the lower bound value for each variable.
|
virtual |
Set/Get the MaximumNumberOfCorrections. Default is 5
|
virtual |
Set/Get the MaximumNumberOfEvaluations. Default is 500
|
virtual |
Set/Get the MaximumNumberOfIterations. Default is 500
|
virtual |
Set/Get the ProjectedGradientTolerance. Algorithm terminates when the project gradient is below the tolerance. Default value is 1e-5.
|
inline |
This optimizer does not support scaling of the derivatives.
Definition at line 179 of file itkLBFGSBOptimizer.h.
|
virtual |
Set/Get the optimizer trace flag. If set to true, the optimizer prints out information every iteration.
|
virtual |
Set the upper bound value for each variable.
|
overridevirtual |
Start optimization with an initial value.
Reimplemented from itk::Optimizer.
|
virtual |
|
virtual |
|
friend |
Set the lower bound value for each variable.
Definition at line 210 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 225 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 214 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 219 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 220 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 223 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 218 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 217 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 216 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 213 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 215 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 212 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 224 of file itkLBFGSBOptimizer.h.
|
private |
Set the lower bound value for each variable.
Definition at line 222 of file itkLBFGSBOptimizer.h.