ITK  4.8.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::MultipleValuedNonLinearVnlOptimizer Class Referenceabstract

#include <itkMultipleValuedNonLinearVnlOptimizer.h>

+ Inheritance diagram for itk::MultipleValuedNonLinearVnlOptimizer:
+ Collaboration diagram for itk::MultipleValuedNonLinearVnlOptimizer:

Detailed Description

This class is a base for the Optimization methods that optimize a multi-valued function.

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

Definition at line 37 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
MultipleValuedNonLinearVnlOptimizer 
Self
 
typedef
MultipleValuedNonLinearOptimizer 
Superclass
 
- Public Types inherited from itk::MultipleValuedNonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef MultipleValuedCostFunction CostFunctionType
 
typedef Array2D< double > DerivativeType
 
typedef Array< double > MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
MultipleValuedNonLinearOptimizer 
Self
 
typedef NonLinearOptimizer Superclass
 
- Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef NonLinearOptimizer Self
 
typedef Optimizer Superclass
 
- Public Types inherited from itk::Optimizer
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Array< double > ScalesType
 
typedef Optimizer Self
 
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
 
bool GetUseCostFunctionGradient () const
 
virtual void SetCostFunction (MultipleValuedCostFunction *costFunction) override=0
 
void SetUseCostFunctionGradient (bool)
 
void UseCostFunctionGradientOff ()
 
void UseCostFunctionGradientOn ()
 
virtual const MeasureTypeGetCachedValue () const
 
virtual const DerivativeTypeGetCachedDerivative () const
 
virtual const ParametersTypeGetCachedCurrentPosition () const
 
- Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::NonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
 
- Public Member Functions inherited from itk::Optimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
virtual const ParametersTypeGetInitialPosition () const
 
virtual const std::string GetStopConditionDescription () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
virtual void StartOptimization ()
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () const
 
- 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
 
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 ReceptorMemberCommand
< Self
CommandType
 
typedef
MultipleValuedVnlCostFunctionAdaptor 
CostFunctionAdaptorType
 

Protected Member Functions

const CostFunctionAdaptorTypeGetCostFunctionAdaptor () const
 
CostFunctionAdaptorTypeGetCostFunctionAdaptor ()
 
CostFunctionAdaptorTypeGetNonConstCostFunctionAdaptor () const
 
 MultipleValuedNonLinearVnlOptimizer ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
void SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
 
virtual ~MultipleValuedNonLinearVnlOptimizer ()
 
- Protected Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
 MultipleValuedNonLinearOptimizer ()
 
virtual ~MultipleValuedNonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()
 
virtual ~NonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
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

void IterationReport (const EventObject &event)
 
 MultipleValuedNonLinearVnlOptimizer (const Self &)
 
void operator= (const Self &)
 

Private Attributes

ParametersType m_CachedCurrentPosition
 
DerivativeType m_CachedDerivative
 
MeasureType m_CachedValue
 
CommandType::Pointer m_Command
 
CostFunctionAdaptorTypem_CostFunctionAdaptor
 
bool m_UseGradient
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::MultipleValuedNonLinearOptimizer
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::MultipleValuedNonLinearOptimizer
CostFunctionPointer m_CostFunction
 
- Protected Attributes inherited from itk::Optimizer
ParametersType m_CurrentPosition
 
bool m_ScalesInitialized
 
- 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 113 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Definition at line 45 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Definition at line 97 of file itkMultipleValuedNonLinearVnlOptimizer.h.

ParametersType typedef. It defines a position in the optimization search space.

Definition at line 49 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Definition at line 44 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Standard class typedefs.

Definition at line 42 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Definition at line 43 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Constructor & Destructor Documentation

itk::MultipleValuedNonLinearVnlOptimizer::MultipleValuedNonLinearVnlOptimizer ( )
protected
virtual itk::MultipleValuedNonLinearVnlOptimizer::~MultipleValuedNonLinearVnlOptimizer ( )
protectedvirtual
itk::MultipleValuedNonLinearVnlOptimizer::MultipleValuedNonLinearVnlOptimizer ( const Self )
private

Member Function Documentation

virtual const ParametersType& itk::MultipleValuedNonLinearVnlOptimizer::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, for mathematical validation you should rather call GetValue().

virtual const DerivativeType& itk::MultipleValuedNonLinearVnlOptimizer::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, for mathematical validation you should rather call GetValue().

virtual const MeasureType& itk::MultipleValuedNonLinearVnlOptimizer::GetCachedValue ( ) 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, for mathematical validation you should rather call GetValue().

const CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor ( ) const
protected
CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor ( )
protected
virtual const char* itk::MultipleValuedNonLinearVnlOptimizer::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::MultipleValuedNonLinearOptimizer.

Reimplemented in itk::LevenbergMarquardtOptimizer.

CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::GetNonConstCostFunctionAdaptor ( ) const
protected

The purpose of this method is to get around the lack of const correctness in vnl cost_functions and optimizers

bool itk::MultipleValuedNonLinearVnlOptimizer::GetUseCostFunctionGradient ( ) const
void itk::MultipleValuedNonLinearVnlOptimizer::IterationReport ( const EventObject event)
private

Callback function for the Command Observer

void itk::MultipleValuedNonLinearVnlOptimizer::operator= ( const Self )
private
virtual void itk::MultipleValuedNonLinearVnlOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::MultipleValuedNonLinearOptimizer.

virtual void itk::MultipleValuedNonLinearVnlOptimizer::SetCostFunction ( MultipleValuedCostFunction costFunction)
overridepure virtual

Set the 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 itkCostFunction. As a consequence each derived optimizer should construct its own CostFunctionAdaptor when overloading this method

Implemented in itk::LevenbergMarquardtOptimizer.

void itk::MultipleValuedNonLinearVnlOptimizer::SetCostFunctionAdaptor ( CostFunctionAdaptorType adaptor)
protected
void itk::MultipleValuedNonLinearVnlOptimizer::SetUseCostFunctionGradient ( bool  )

Define if the Cost function should provide a customized Gradient computation or the gradient can be computed internally using a default approach

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOff ( )
inline

Definition at line 73 of file itkMultipleValuedNonLinearVnlOptimizer.h.

void itk::MultipleValuedNonLinearVnlOptimizer::UseCostFunctionGradientOn ( )
inline

Definition at line 68 of file itkMultipleValuedNonLinearVnlOptimizer.h.

Member Data Documentation

ParametersType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedCurrentPosition
mutableprivate

Definition at line 127 of file itkMultipleValuedNonLinearVnlOptimizer.h.

DerivativeType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedDerivative
mutableprivate

Definition at line 129 of file itkMultipleValuedNonLinearVnlOptimizer.h.

MeasureType itk::MultipleValuedNonLinearVnlOptimizer::m_CachedValue
mutableprivate

Definition at line 128 of file itkMultipleValuedNonLinearVnlOptimizer.h.

CommandType::Pointer itk::MultipleValuedNonLinearVnlOptimizer::m_Command
private

Definition at line 125 of file itkMultipleValuedNonLinearVnlOptimizer.h.

CostFunctionAdaptorType* itk::MultipleValuedNonLinearVnlOptimizer::m_CostFunctionAdaptor
private

Definition at line 122 of file itkMultipleValuedNonLinearVnlOptimizer.h.

bool itk::MultipleValuedNonLinearVnlOptimizer::m_UseGradient
private

Definition at line 123 of file itkMultipleValuedNonLinearVnlOptimizer.h.


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