ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkLBFGSOptimizerv4.h>
Wrap of the vnl_lbfgs algorithm for use in ITKv4 registration framework.
Definition at line 32 of file itkLBFGSOptimizerv4.h.
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) 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) ITK_OVERRIDE |
virtual void | StartOptimization (bool doOnlyInitialization=false) ITK_OVERRIDE |
void | VerboseOff (void) |
void | VerboseOn (void) |
Public Member Functions inherited from itk::LBFGSOptimizerBasev4< vnl_lbfgs > | |
virtual double | GetGradientConvergenceTolerance () const |
virtual unsigned int | GetMaximumNumberOfFunctionEvaluations () const |
InternalOptimizerType * | GetOptimizer (void) |
virtual const StopConditionReturnStringType | GetStopConditionDescription () const ITK_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 (void) 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 (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
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 Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
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 |
unsigned int | m_MaximumNumberOfIterations |
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 | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
typedef SmartPointer< const Self > itk::LBFGSOptimizerv4::ConstPointer |
Definition at line 40 of file itkLBFGSOptimizerv4.h.
|
protected |
Internal optimizer type.
Definition at line 88 of file itkLBFGSOptimizerv4.h.
|
protected |
InternalParameters typedef.
Definition at line 85 of file itkLBFGSOptimizerv4.h.
typedef Superclass::MetricType itk::LBFGSOptimizerv4::MetricType |
Definition at line 42 of file itkLBFGSOptimizerv4.h.
typedef Superclass::ParametersType itk::LBFGSOptimizerv4::ParametersType |
Definition at line 43 of file itkLBFGSOptimizerv4.h.
typedef SmartPointer< Self > itk::LBFGSOptimizerv4::Pointer |
Definition at line 39 of file itkLBFGSOptimizerv4.h.
typedef Superclass::ScalesType itk::LBFGSOptimizerv4::ScalesType |
Definition at line 44 of file itkLBFGSOptimizerv4.h.
Standard "Self" typedef.
Definition at line 37 of file itkLBFGSOptimizerv4.h.
typedef LBFGSOptimizerBasev4<vnl_lbfgs> itk::LBFGSOptimizerv4::Superclass |
Definition at line 38 of file itkLBFGSOptimizerv4.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 |
Run-time type information (and related methods).
Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgs >.
|
static |
Method for creation through the object factory.
|
private |
|
protectedvirtual |
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 |
Plug in a Cost Function into the optimizer
Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgs >.
|
virtual |
Start optimization with an initial value.
Reimplemented from itk::LBFGSOptimizerBasev4< vnl_lbfgs >.
void itk::LBFGSOptimizerv4::VerboseOff | ( | void | ) |
void itk::LBFGSOptimizerv4::VerboseOn | ( | void | ) |
|
private |
Definition at line 96 of file itkLBFGSOptimizerv4.h.
|
private |
Definition at line 95 of file itkLBFGSOptimizerv4.h.
|
private |
Definition at line 94 of file itkLBFGSOptimizerv4.h.