ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::MultiStartOptimizerv4Template< TInternalComputationValueType > Class Template Reference

#include <itkMultiStartOptimizerv4.h>

+ Inheritance diagram for itk::MultiStartOptimizerv4Template< TInternalComputationValueType >:
+ Collaboration diagram for itk::MultiStartOptimizerv4Template< TInternalComputationValueType >:

Detailed Description

template<typename TInternalComputationValueType>
class itk::MultiStartOptimizerv4Template< TInternalComputationValueType >

Multi-start searches over input parameters and returns the best metric value.

The multi-start algorithm performs gradient descent from N (large) number of starting points and returns the best solution. Ideal start points would sample the solution space almost uniformly, thus, in theory, this is a global optimizer. In this implementation, the quality of the optimization depends on the parameter space samples that the user inputs to the optimizer. Multi-start can be modified in numerous ways to improve robustness of standard approaches. These improvements usually focus modifying the parameter sample space. This is why we place the burden on the user to provide the parameter samples over which to optimize.

Definition at line 40 of file itkMultiStartOptimizerv4.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef MetricType::DerivativeType DerivativeType
 
typedef
TInternalComputationValueType 
InternalComputationValueType
 
typedef LocalOptimizerType::Pointer LocalOptimizerPointer
 
typedef
itk::GradientDescentOptimizerv4Template
< TInternalComputationValueType > 
LocalOptimizerType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::MetricType MetricType
 
typedef MetricType::Pointer MetricTypePointer
 
typedef std::vector< MeasureTypeMetricValuesListType
 
typedef OptimizerType::Pointer OptimizerPointer
 
typedef
ObjectToObjectOptimizerBaseTemplate
< TInternalComputationValueType > 
OptimizerType
 
typedef
ParametersListType::size_type 
ParameterListSizeType
 
typedef std::vector
< ParametersType
ParametersListType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
MultiStartOptimizerv4Template 
Self
 
typedef
Superclass::StopConditionDescriptionType 
StopConditionDescriptionType
 
typedef
Superclass::StopConditionReturnStringType 
StopConditionReturnStringType
 
enum  StopConditionType {
  MAXIMUM_NUMBER_OF_ITERATIONS,
  COSTFUNCTION_ERROR,
  UPDATE_PARAMETERS_ERROR,
  STEP_TOO_SMALL,
  CONVERGENCE_CHECKER_PASSED,
  OTHER_ERROR
}
 
typedef
ObjectToObjectOptimizerBaseTemplate
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef MetricType::DerivativeType DerivativeType
 
typedef MetricType::MeasureType MeasureType
 
typedef
ObjectToObjectMetricBaseTemplate
< TInternalComputationValueType > 
MetricType
 
typedef MetricType::Pointer MetricTypePointer
 
typedef
MetricType::NumberOfParametersType 
NumberOfParametersType
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
OptimizerParameterScalesEstimatorTemplate
< TInternalComputationValueType > 
ScalesEstimatorType
 
typedef OptimizerParameters
< TInternalComputationValueType > 
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 ::itk::LightObject::Pointer CreateAnother () const
 
ParametersType GetBestParameters ()
 
ParameterListSizeType GetBestParametersIndex ()
 
const MetricValuesListTypeGetMetricValuesList () const
 
virtual const char * GetNameOfClass () const
 
ParametersListTypeGetParametersList ()
 
virtual const StopConditionTypeGetStopCondition () const
 
virtual const
StopConditionReturnStringType 
GetStopConditionDescription () const override
 
void InstantiateLocalOptimizer ()
 
virtual void ResumeOptimization ()
 
void SetParametersList (ParametersListType &p)
 
virtual void StartOptimization (bool doOnlyInitialization=false) override
 
virtual void StopOptimization ()
 
virtual void SetLocalOptimizer (OptimizerType *_arg)
 
virtual OptimizerTypeGetModifiableLocalOptimizer ()
 
virtual const OptimizerTypeGetLocalOptimizer () const
 
- Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
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 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
 

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 Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 MultiStartOptimizerv4Template ()
 
virtual ~MultiStartOptimizerv4Template ()
 
- Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
 ObjectToObjectOptimizerBaseTemplate ()
 
virtual ~ObjectToObjectOptimizerBaseTemplate ()
 
- 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 ()
 

Protected Attributes

ParameterListSizeType m_BestParametersIndex
 
OptimizerPointer m_LocalOptimizer
 
MeasureType m_MaximumMetricValue
 
MetricValuesListType m_MetricValuesList
 
MeasureType m_MinimumMetricValue
 
ParametersListType m_ParametersList
 
bool m_Stop
 
StopConditionType m_StopCondition
 
StopConditionDescriptionType m_StopConditionDescription
 
- Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
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
 

Private Member Functions

 MultiStartOptimizerv4Template (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Member Typedef Documentation

template<typename TInternalComputationValueType >
typedef SmartPointer< const Self > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ConstPointer

Definition at line 48 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef MetricType::DerivativeType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::DerivativeType

Derivative type

Definition at line 91 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef TInternalComputationValueType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::InternalComputationValueType

Stop condition return string type It should be possible to derive the internal computation type from the class object.

Definition at line 84 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef LocalOptimizerType::Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerPointer

Definition at line 63 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef itk::GradientDescentOptimizerv4Template<TInternalComputationValueType> itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::LocalOptimizerType

Definition at line 62 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::MeasureType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MeasureType

Measure type

Definition at line 94 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::MetricType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MetricType

Metric type over which this class is templated

Definition at line 87 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef MetricType::Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MetricTypePointer

Definition at line 88 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef std::vector< MeasureType > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MetricValuesListType

Definition at line 95 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef OptimizerType::Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::OptimizerPointer

Definition at line 61 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::OptimizerType

Definition at line 60 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef ParametersListType::size_type itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ParameterListSizeType

Definition at line 58 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef std::vector< ParametersType > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ParametersListType

Definition at line 57 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::ParametersType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ParametersType

Definition at line 54 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef SmartPointer< Self > itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::Pointer

Definition at line 47 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef MultiStartOptimizerv4Template itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::Self

Standard class typedefs.

Definition at line 45 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::StopConditionDescriptionType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::StopConditionDescriptionType

Stop condition internal string type

Definition at line 79 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef Superclass::StopConditionReturnStringType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::StopConditionReturnStringType

Stop condition return string type

Definition at line 76 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::Superclass

Definition at line 46 of file itkMultiStartOptimizerv4.h.

Member Enumeration Documentation

template<typename TInternalComputationValueType >
enum itk::MultiStartOptimizerv4Template::StopConditionType

Codes of stopping conditions.

Enumerator
MAXIMUM_NUMBER_OF_ITERATIONS 
COSTFUNCTION_ERROR 
UPDATE_PARAMETERS_ERROR 
STEP_TOO_SMALL 
CONVERGENCE_CHECKER_PASSED 
OTHER_ERROR 

Definition at line 66 of file itkMultiStartOptimizerv4.h.

Constructor & Destructor Documentation

template<typename TInternalComputationValueType >
itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MultiStartOptimizerv4Template ( )
protected

Default constructor

template<typename TInternalComputationValueType >
virtual itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::~MultiStartOptimizerv4Template ( )
protectedvirtual

Default constructor

template<typename TInternalComputationValueType >
itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::MultiStartOptimizerv4Template ( const Self )
private

Member Function Documentation

template<typename TInternalComputationValueType >
virtual::itk::LightObject::Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::CreateAnother ( ) const
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.

template<typename TInternalComputationValueType >
ParametersType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetBestParameters ( )

Return the parameters from the best visited position

template<typename TInternalComputationValueType >
ParameterListSizeType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetBestParametersIndex ( )
inline
template<typename TInternalComputationValueType >
virtual const OptimizerType* itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetLocalOptimizer ( ) const
virtual

Set/Get the optimizer.

template<typename TInternalComputationValueType >
const MetricValuesListType& itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetMetricValuesList ( ) const

Get the list of metric values that we produced after the multi-start search.

template<typename TInternalComputationValueType >
virtual OptimizerType* itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetModifiableLocalOptimizer ( )
virtual

Set/Get the optimizer.

template<typename TInternalComputationValueType >
virtual const char* itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
ParametersListType& itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetParametersList ( )

Get the list of parameters over which to search.

template<typename TInternalComputationValueType >
virtual const StopConditionType& itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetStopCondition ( ) const
virtual

Get stop condition enum

template<typename TInternalComputationValueType >
virtual const StopConditionReturnStringType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::GetStopConditionDescription ( ) const
overridevirtual
template<typename TInternalComputationValueType >
void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::InstantiateLocalOptimizer ( )

Create an instance of the local optimizer

template<typename TInternalComputationValueType >
static Pointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::New ( )
static

Method for creation through the object factory.

template<typename TInternalComputationValueType >
void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::operator= ( const Self )
private
template<typename TInternalComputationValueType >
virtual void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::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::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

template<typename TInternalComputationValueType >
virtual void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::ResumeOptimization ( )
virtual

Resume the optimization. Can be called after StopOptimization to resume. The bulk of the optimization work loop is here.

template<typename TInternalComputationValueType >
virtual void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::SetLocalOptimizer ( OptimizerType _arg)
virtual

Set/Get the optimizer.

template<typename TInternalComputationValueType >
void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::SetParametersList ( ParametersListType p)

Set the list of parameters over which to search

template<typename TInternalComputationValueType >
virtual void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::StartOptimization ( bool  doOnlyInitialization = false)
overridevirtual
template<typename TInternalComputationValueType >
virtual void itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::StopOptimization ( )
virtual

Stop optimization. The object is left in a state so the optimization can be resumed by calling ResumeOptimization.

Member Data Documentation

template<typename TInternalComputationValueType >
ParameterListSizeType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_BestParametersIndex
protected
template<typename TInternalComputationValueType >
OptimizerPointer itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_LocalOptimizer
protected

Definition at line 153 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
MeasureType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_MaximumMetricValue
protected

Definition at line 151 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
MetricValuesListType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_MetricValuesList
protected

Definition at line 149 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
MeasureType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_MinimumMetricValue
protected

Definition at line 150 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
ParametersListType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_ParametersList
protected

Definition at line 148 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
bool itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_Stop
protected

Definition at line 145 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
StopConditionType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_StopCondition
protected

Definition at line 146 of file itkMultiStartOptimizerv4.h.

template<typename TInternalComputationValueType >
StopConditionDescriptionType itk::MultiStartOptimizerv4Template< TInternalComputationValueType >::m_StopConditionDescription
protected

Definition at line 147 of file itkMultiStartOptimizerv4.h.


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