ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::SingleValuedNonLinearVnlOptimizerv4 Class Referenceabstract

#include <itkSingleValuedNonLinearVnlOptimizerv4.h>

+ Inheritance diagram for itk::SingleValuedNonLinearVnlOptimizerv4:
+ Collaboration diagram for itk::SingleValuedNonLinearVnlOptimizerv4:

Detailed Description

This is a base for the ITKv4 Optimization methods using the vnl library.

It is an Adaptor class for optimizers provided by the vnl library.

Definition at line 37 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Public Types

typedef ReceptorMemberCommand
< Self
CommandType
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::MetricType MetricType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef
SingleValuedNonLinearVnlOptimizerv4 
Self
 
typedef
Superclass::StopConditionDescriptionType 
StopConditionDescriptionType
 
typedef
Superclass::StopConditionReturnStringType 
StopConditionReturnStringType
 
typedef ObjectToObjectOptimizerBase Superclass
 
- Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
typedef SmartPointer< const SelfConstPointer
 
typedef MetricType::DerivativeType DerivativeType
 
typedef MetricType::MeasureType MeasureType
 
typedef
ObjectToObjectMetricBaseTemplate
< double > 
MetricType
 
typedef MetricType::Pointer MetricTypePointer
 
typedef
MetricType::NumberOfParametersType 
NumberOfParametersType
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
OptimizerParameterScalesEstimatorTemplate
< double > 
ScalesEstimatorType
 
typedef OptimizerParameters
< double > 
ScalesType
 
typedef
ObjectToObjectOptimizerBaseTemplate 
Self
 
typedef std::ostringstream StopConditionDescriptionType
 
typedef std::string StopConditionReturnStringType
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
virtual const
StopConditionReturnStringType 
GetStopConditionDescription () const override=0
 
virtual void SetMetric (MetricType *metric) override=0
 
virtual 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 const MeasureTypeGetCurrentMetricValue () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
virtual SizeValueType GetNumberOfIterations () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual const ScalesTypeGetScales () const
 
virtual const bool & GetScalesAreIdentity () const
 
bool GetScalesInitialized () const
 
virtual const MeasureTypeGetValue () const
 
virtual const ScalesTypeGetWeights () 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 MetricTypeGetModifiableMetric ()
 
virtual const MetricTypeGetMetric () 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 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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
SingleValuedVnlCostFunctionAdaptorv4 
CostFunctionAdaptorType
 

Protected Member Functions

const CostFunctionAdaptorTypeGetCostFunctionAdaptor () const
 
CostFunctionAdaptorTypeGetCostFunctionAdaptor ()
 
CostFunctionAdaptorTypeGetNonConstCostFunctionAdaptor () const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
void SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
 
 SingleValuedNonLinearVnlOptimizerv4 ()
 
virtual ~SingleValuedNonLinearVnlOptimizerv4 () override
 
- Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< double >
 ObjectToObjectOptimizerBaseTemplate ()
 
virtual ~ObjectToObjectOptimizerBaseTemplate () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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 Member Functions

void IterationReport (const EventObject &event)
 

Private Attributes

ParametersType m_CachedCurrentPosition
 
DerivativeType m_CachedDerivative
 
CommandType::Pointer m_Command
 
CostFunctionAdaptorTypem_CostFunctionAdaptor
 

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 ()
 
- 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
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

Command observer that will interact with the ITKVNL cost-function adaptor in order to generate iteration events. This will allow to overcome the limitation of VNL optimizers not offering callbacks for every iteration

Definition at line 54 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 45 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 93 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 57 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 56 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 58 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 44 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 59 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Standard class typedefs.

Definition at line 42 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

typedef Superclass::StopConditionDescriptionType itk::SingleValuedNonLinearVnlOptimizerv4::StopConditionDescriptionType

Stop condition internal string type

Definition at line 65 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

typedef Superclass::StopConditionReturnStringType itk::SingleValuedNonLinearVnlOptimizerv4::StopConditionReturnStringType

Stop condition return string type

Definition at line 62 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Definition at line 43 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

Constructor & Destructor Documentation

itk::SingleValuedNonLinearVnlOptimizerv4::SingleValuedNonLinearVnlOptimizerv4 ( )
protected
virtual itk::SingleValuedNonLinearVnlOptimizerv4::~SingleValuedNonLinearVnlOptimizerv4 ( )
overrideprotectedvirtual

Member Function Documentation

virtual const ParametersType& itk::SingleValuedNonLinearVnlOptimizerv4::GetCachedCurrentPosition ( ) const
virtual

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option.

Note
The metric value is cached in the base class, retrieved via GetValue().
virtual const DerivativeType& itk::SingleValuedNonLinearVnlOptimizerv4::GetCachedDerivative ( ) const
virtual

Return Cached Values. These method have the advantage of not triggering a recomputation of the metric value, but it has the disadvantage of returning a value that may not be the one corresponding to the current parameters. For GUI update purposes, this method is a good option.

Note
The metric value is cached in the base class, retrieved via GetValue().
const CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizerv4::GetCostFunctionAdaptor ( ) const
protected
CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizerv4::GetCostFunctionAdaptor ( )
protected
virtual const char* itk::SingleValuedNonLinearVnlOptimizerv4::GetNameOfClass ( ) const
virtual
CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizerv4::GetNonConstCostFunctionAdaptor ( ) const
protected

The purpose of this method is to get around the lack of const-correctness in VNL cost-functions and optimizers

virtual const StopConditionReturnStringType itk::SingleValuedNonLinearVnlOptimizerv4::GetStopConditionDescription ( ) const
overridepure virtual
void itk::SingleValuedNonLinearVnlOptimizerv4::IterationReport ( const EventObject event)
private

The purpose of this method is to get around the lack of iteration reporting in VNL optimizers. By interfacing directly with the ITK cost function adaptor we are generating here Iteration Events. Note the iteration events here are produce PER EVALUATION of the metric, not per real iteration of the vnl optimizer. Optimizers that evaluate the metric multiple times at each iteration will generate a lot more of Iteration events here.

virtual void itk::SingleValuedNonLinearVnlOptimizerv4::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual
void itk::SingleValuedNonLinearVnlOptimizerv4::SetCostFunctionAdaptor ( CostFunctionAdaptorType adaptor)
protected
virtual void itk::SingleValuedNonLinearVnlOptimizerv4::SetMetric ( MetricType metric)
overridepure virtual

Set the metric (cost function). This method has to be overloaded by derived classes because the CostFunctionAdaptor requires to know the number of parameters at construction time. This number of parameters is obtained at run-time from the itkObjectToObjectMetric. As a consequence each derived optimizer should construct its own CostFunctionAdaptor when overloading this method

Implemented in itk::LBFGSBOptimizerv4, itk::LBFGSOptimizerv4, itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >, itk::LBFGSOptimizerBasev4< vnl_lbfgs >, itk::LBFGSOptimizerBasev4< vnl_lbfgsb >, and itk::AmoebaOptimizerv4.

virtual void itk::SingleValuedNonLinearVnlOptimizerv4::StartOptimization ( bool  doOnlyInitialization = false)
overridevirtual

Run the optimization.

Parameters
doOnlyInitializationThis is false by default. It should only be set to true for special cases when the class should be initialized to perform optimization, but no optimization should be run. For example, itkMultiGradientOptimizerv4 needs to do this.
Note
Derived classes must override and call this superclass method, then perform any additional initialization before performing optimization.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< double >.

Reimplemented in itk::LBFGSBOptimizerv4, itk::LBFGSOptimizerv4, itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >, itk::LBFGSOptimizerBasev4< vnl_lbfgs >, itk::LBFGSOptimizerBasev4< vnl_lbfgsb >, and itk::AmoebaOptimizerv4.

Member Data Documentation

ParametersType itk::SingleValuedNonLinearVnlOptimizerv4::m_CachedCurrentPosition
mutableprivate

Definition at line 123 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

DerivativeType itk::SingleValuedNonLinearVnlOptimizerv4::m_CachedDerivative
mutableprivate

Definition at line 124 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

CommandType::Pointer itk::SingleValuedNonLinearVnlOptimizerv4::m_Command
private

Definition at line 121 of file itkSingleValuedNonLinearVnlOptimizerv4.h.

CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizerv4::m_CostFunctionAdaptor
private

Definition at line 117 of file itkSingleValuedNonLinearVnlOptimizerv4.h.


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