ITK
4.4.0
Insight Segmentation and Registration Toolkit
|
#include <itkLBFGSOptimizer.h>
Wrap of the vnl_lbfgs algorithm.
Definition at line 32 of file itkLBFGSOptimizer.h.
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual double | GetDefaultStepLength () |
virtual double | GetGradientConvergenceTolerance () |
virtual double | GetLineSearchAccuracy () |
virtual unsigned int | GetMaximumNumberOfFunctionEvaluations () |
virtual const char * | GetNameOfClass () const |
vnl_lbfgs * | GetOptimizer (void) |
const std::string | GetStopConditionDescription () const |
virtual bool | GetTrace () |
MeasureType | GetValue () const |
virtual void | SetCostFunction (SingleValuedCostFunction *costFunction) |
virtual void | SetDefaultStepLength (double stp) |
virtual void | SetGradientConvergenceTolerance (double gtol) |
virtual void | SetLineSearchAccuracy (double tol) |
virtual void | SetMaximumNumberOfFunctionEvaluations (unsigned int n) |
virtual void | SetTrace (bool flag) |
void | StartOptimization (void) |
virtual void | TraceOff () |
virtual void | TraceOn () |
Public Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizer | |
virtual const bool & | GetMaximize () |
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 () |
virtual const DerivativeType & | GetCachedDerivative () |
virtual const ParametersType & | GetCachedCurrentPosition () |
Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual const CostFunctionType * | GetCostFunction () const |
virtual CostFunctionType * | GetModifiableCostFunction () |
MeasureType | GetValue (const ParametersType ¶meters) const |
virtual void | SetCostFunction (CostFunctionType *costFunction) |
Static Public Member Functions | |
static Pointer | New () |
Protected Types | |
typedef Superclass::CostFunctionAdaptorType | CostFunctionAdaptorType |
Protected Types inherited from itk::SingleValuedNonLinearVnlOptimizer | |
typedef SingleValuedVnlCostFunctionAdaptor | CostFunctionAdaptorType |
Protected Member Functions | |
LBFGSOptimizer () | |
void | PrintSelf (std::ostream &os, Indent indent) const |
virtual | ~LBFGSOptimizer () |
Protected Member Functions inherited from itk::SingleValuedNonLinearVnlOptimizer | |
const CostFunctionAdaptorType * | GetCostFunctionAdaptor (void) const |
CostFunctionAdaptorType * | GetCostFunctionAdaptor (void) |
CostFunctionAdaptorType * | GetNonConstCostFunctionAdaptor (void) const |
void | PrintSelf (std::ostream &os, Indent indent) const |
void | SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor) |
SingleValuedNonLinearVnlOptimizer () | |
virtual | ~SingleValuedNonLinearVnlOptimizer () |
Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer | |
SingleValuedNonLinearOptimizer () | |
virtual | ~SingleValuedNonLinearOptimizer () |
Protected Member Functions inherited from itk::NonLinearOptimizer | |
NonLinearOptimizer () | |
virtual | ~NonLinearOptimizer () |
Protected Member Functions inherited from itk::Optimizer | |
Optimizer () | |
virtual void | SetCurrentPosition (const ParametersType ¶m) |
virtual | ~Optimizer () |
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 | |
LBFGSOptimizer (const Self &) | |
void | operator= (const Self &) |
Private Attributes | |
double | m_DefaultStepLength |
double | m_GradientConvergenceTolerance |
double | m_LineSearchAccuracy |
unsigned int | m_MaximumNumberOfFunctionEvaluations |
bool | m_OptimizerInitialized |
std::ostringstream | m_StopConditionDescription |
bool | m_Trace |
InternalOptimizerType * | m_VnlOptimizer |
Additional Inherited Members | |
Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer | |
CostFunctionPointer | m_CostFunction |
typedef SmartPointer< const Self > itk::LBFGSOptimizer::ConstPointer |
Definition at line 40 of file itkLBFGSOptimizer.h.
|
protected |
Definition at line 114 of file itkLBFGSOptimizer.h.
typedef vnl_lbfgs itk::LBFGSOptimizer::InternalOptimizerType |
Internal optimizer type.
Definition at line 52 of file itkLBFGSOptimizer.h.
typedef vnl_vector< double > itk::LBFGSOptimizer::InternalParametersType |
InternalParameters typedef.
Definition at line 46 of file itkLBFGSOptimizer.h.
typedef SmartPointer< Self > itk::LBFGSOptimizer::Pointer |
Definition at line 39 of file itkLBFGSOptimizer.h.
Standard "Self" typedef.
Definition at line 37 of file itkLBFGSOptimizer.h.
Definition at line 38 of file itkLBFGSOptimizer.h.
|
protected |
|
protectedvirtual |
|
private |
|
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 |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.
vnl_lbfgs* itk::LBFGSOptimizer::GetOptimizer | ( | void | ) |
Method for getting access to the internal optimizer.
|
virtual |
Get the reason for termination
Reimplemented from itk::Optimizer.
|
virtual |
MeasureType itk::LBFGSOptimizer::GetValue | ( | ) | const |
Return Current Value
|
static |
Method for creation through the object factory.
|
private |
|
protectedvirtual |
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.
|
virtual |
Plug in a Cost Function into the optimizer
Implements itk::SingleValuedNonLinearVnlOptimizer.
|
virtual |
Set/Get the default step size. This is a positive real number with a default value of 1.0 which determines the stpe size in the line search.
|
virtual |
Set/Get the gradient convergence tolerance. This is a positive real number that determines the accuracy with which the solution is to be found. The optimization terminates when: ||G|| < gtol max(1,||X||) where ||.|| denotes the Euclidean norm.
|
virtual |
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 |
Set/Get the maximum number of function evaluations allowed.
|
virtual |
Set/Get the optimizer trace flag. If set to true, the optimizer prints out information every iteration.
|
virtual |
Start optimization with an initial value.
Reimplemented from itk::Optimizer.
|
virtual |
|
virtual |
|
private |
Definition at line 128 of file itkLBFGSOptimizer.h.
|
private |
Definition at line 126 of file itkLBFGSOptimizer.h.
|
private |
Definition at line 127 of file itkLBFGSOptimizer.h.
|
private |
Definition at line 125 of file itkLBFGSOptimizer.h.
|
private |
Definition at line 120 of file itkLBFGSOptimizer.h.
|
mutableprivate |
Definition at line 122 of file itkLBFGSOptimizer.h.
|
private |
Definition at line 124 of file itkLBFGSOptimizer.h.
|
private |
Definition at line 121 of file itkLBFGSOptimizer.h.