ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkLBFGSOptimizerBasev4.h>
Abstract base for vnl lbfgs algorithm optimizers in ITKv4 registration framework.
m_VnlOptimizer->get_failure_code()
. This seems to return "Failure" even when no error has occured. The same behavior is observed in the ITKv3 version of this optimizer.This code has been adapted for the ITKv4 registration framework from the v3 version, itkLBFGSOptimizer.
Definition at line 72 of file itkLBFGSOptimizerBasev4.h.
Public Member Functions | |
virtual double | GetGradientConvergenceTolerance () const |
virtual unsigned int | GetMaximumNumberOfFunctionEvaluations () const |
virtual const char * | GetNameOfClass () 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 | SetMetric (MetricType *metric) ITK_OVERRIDE |
virtual void | SetTrace (bool flag) |
virtual void | StartOptimization (bool doOnlyInitialization=false) ITK_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 & | 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 LightObject::Pointer | CreateAnother () const ITK_OVERRIDE |
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 |
Protected Types | |
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 |
Protected Attributes | |
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 |
Private Member Functions | |
LBFGSOptimizerBasev4 (const Self &) | |
void | operator= (const Self &) |
Friends | |
class | LBFGSBOptimizerHelperv4 |
class | LBFGSOptimizerBaseHelperv4< TInternalVnlOptimizerType > |
Additional Inherited Members | |
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 () |
typedef SmartPointer< const Self > itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::ConstPointer |
Definition at line 80 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 137 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 141 of file itkLBFGSOptimizerBasev4.h.
typedef LBFGSOptimizerBaseHelperv4<TInternalVnlOptimizerType> itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::InternalOptimizerType |
The vnl optimizer
Definition at line 96 of file itkLBFGSOptimizerBasev4.h.
typedef Superclass::MetricType itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::MetricType |
Definition at line 83 of file itkLBFGSOptimizerBasev4.h.
typedef Superclass::ParametersType itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::ParametersType |
Definition at line 86 of file itkLBFGSOptimizerBasev4.h.
typedef SmartPointer< Self > itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::Pointer |
Definition at line 79 of file itkLBFGSOptimizerBasev4.h.
typedef Superclass::ScalesType itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::ScalesType |
Definition at line 87 of file itkLBFGSOptimizerBasev4.h.
typedef LBFGSOptimizerBasev4 itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::Self |
Standard "Self" typedef.
Definition at line 77 of file itkLBFGSOptimizerBasev4.h.
typedef Superclass::StopConditionDescriptionType itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::StopConditionDescriptionType |
Stop condition internal string type
Definition at line 93 of file itkLBFGSOptimizerBasev4.h.
typedef Superclass::StopConditionReturnStringType itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::StopConditionReturnStringType |
Stop condition return string type
Definition at line 90 of file itkLBFGSOptimizerBasev4.h.
typedef SingleValuedNonLinearVnlOptimizerv4 itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::Superclass |
Definition at line 78 of file itkLBFGSOptimizerBasev4.h.
|
protected |
|
protectedvirtual |
|
private |
|
virtual |
|
virtual |
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::SingleValuedNonLinearVnlOptimizerv4.
Reimplemented in itk::LBFGSBOptimizerv4, and itk::LBFGSOptimizerv4.
InternalOptimizerType* itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >::GetOptimizer | ( | void | ) |
Method for getting access to the internal optimizer.
|
virtual |
Get the reason for termination
Implements itk::SingleValuedNonLinearVnlOptimizerv4.
|
virtual |
|
private |
|
protectedvirtual |
Print out internal state
Reimplemented from itk::SingleValuedNonLinearVnlOptimizerv4.
Reimplemented in itk::LBFGSBOptimizerv4, and itk::LBFGSOptimizerv4.
|
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 maximum number of function evaluations allowed.
|
virtual |
Plug in a Cost Function into the optimizer
Implements itk::SingleValuedNonLinearVnlOptimizerv4.
Reimplemented in itk::LBFGSBOptimizerv4, and itk::LBFGSOptimizerv4.
|
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::SingleValuedNonLinearVnlOptimizerv4.
Reimplemented in itk::LBFGSBOptimizerv4, and itk::LBFGSOptimizerv4.
|
virtual |
|
virtual |
|
friend |
Definition at line 156 of file itkLBFGSOptimizerBasev4.h.
|
friend |
Definition at line 155 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 151 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 148 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 149 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 147 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 150 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 139 of file itkLBFGSOptimizerBasev4.h.
|
mutableprotected |
Definition at line 144 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 146 of file itkLBFGSOptimizerBasev4.h.
|
protected |
Definition at line 142 of file itkLBFGSOptimizerBasev4.h.