ITK  4.4.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::MultiStartOptimizerv4 Class Reference

#include <itkMultiStartOptimizerv4.h>

+ Inheritance diagram for itk::MultiStartOptimizerv4:
+ Collaboration diagram for itk::MultiStartOptimizerv4:

Detailed Description

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 39 of file itkMultiStartOptimizerv4.h.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef MetricType::DerivativeType DerivativeType
typedef Superclass::MeasureType MeasureType
typedef Superclass::MetricType MetricType
typedef MetricType::Pointer MetricTypePointer
typedef std::vector< MeasureTypeMetricValuesListType
typedef OptimizerType::Pointer OptimizerPointer
typedef ObjectToObjectOptimizerBase OptimizerType
typedef std::vector
< ParametersType
typedef Superclass::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef MultiStartOptimizerv4 Self
typedef std::ostringstream StopConditionDescriptionType
typedef std::string StopConditionReturnStringType
enum  StopConditionType {
typedef ObjectToObjectOptimizerBase Superclass
- Public Types inherited from itk::ObjectToObjectOptimizerBase
typedef SmartPointer< const SelfConstPointer
typedef MetricType::MeasureType MeasureType
typedef ObjectToObjectMetricBase MetricType
typedef MetricType::Pointer MetricTypePointer
typedef OptimizerParameters
< double > 
typedef SmartPointer< SelfPointer
typedef OptimizerParameters
< double > 
typedef ObjectToObjectOptimizerBase 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 ::itk::LightObject::Pointer CreateAnother (void) const
ParametersType GetBestParameters ()
ParameterListSizeType GetBestParametersIndex ()
virtual SizeValueType GetCurrentIteration () const
const MetricValuesListTypeGetMetricValuesList () const
virtual const char * GetNameOfClass () const
virtual const SizeValueTypeGetNumberOfIterations ()
ParametersListTypeGetParametersList ()
virtual const StopConditionTypeGetStopCondition ()
virtual const
GetStopConditionDescription () const
void InstantiateLocalOptimizer (void)
virtual void ResumeOptimization ()
virtual void SetNumberOfIterations (SizeValueType _arg)
void SetParametersList (ParametersListType &p)
virtual void StartOptimization (bool doOnlyInitialization=false)
virtual void StopOptimization (void)
virtual void SetLocalOptimizer (OptimizerType *_arg)
virtual OptimizerTypeGetModifiableLocalOptimizer ()
virtual const OptimizerTypeGetLocalOptimizer () const
- Public Member Functions inherited from itk::ObjectToObjectOptimizerBase
virtual const MeasureTypeGetCurrentMetricValue ()
const ParametersTypeGetCurrentPosition ()
virtual const ThreadIdTypeGetNumberOfThreads ()
virtual const ScalesTypeGetScales ()
virtual const bool & GetScalesAreIdentity ()
const MeasureTypeGetValue ()
virtual const ScalesTypeGetWeights ()
virtual const bool & GetWeightsAreIdentity ()
virtual void SetNumberOfThreads (ThreadIdType number)
virtual void SetScales (ScalesType _arg)
virtual void SetWeights (ScalesType _arg)
virtual void SetMetric (MetricType *_arg)
virtual MetricTypeGetModifiableMetric ()
virtual const MetricTypeGetMetric () 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 (void)
const MetaDataDictionaryGetMetaDataDictionary (void) 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
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 ()

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const
 MultiStartOptimizerv4 ()
virtual ~MultiStartOptimizerv4 ()
- Protected Member Functions inherited from itk::ObjectToObjectOptimizerBase
 ObjectToObjectOptimizerBase ()
virtual ~ObjectToObjectOptimizerBase ()
- 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
SizeValueType m_CurrentIteration
OptimizerPointer m_LocalOptimizer
MeasureType m_MaximumMetricValue
MetricValuesListType m_MetricValuesList
MeasureType m_MinimumMetricValue
SizeValueType m_NumberOfIterations
ParametersListType m_ParametersList
bool m_Stop
StopConditionType m_StopCondition
StopConditionDescriptionType m_StopConditionDescription
- Protected Attributes inherited from itk::ObjectToObjectOptimizerBase
MeasureType m_CurrentMetricValue
MetricTypePointer m_Metric
ThreadIdType m_NumberOfThreads
ScalesType m_Scales
bool m_ScalesAreIdentity
ScalesType m_Weights
bool m_WeightsAreIdentity

Private Member Functions

 MultiStartOptimizerv4 (const Self &)
void operator= (const Self &)

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType

Member Typedef Documentation

Definition at line 47 of file itkMultiStartOptimizerv4.h.

typedef MetricType::DerivativeType itk::MultiStartOptimizerv4::DerivativeType

Derivative type

Definition at line 84 of file itkMultiStartOptimizerv4.h.

typedef Superclass::InternalComputationValueType itk::MultiStartOptimizerv4::InternalComputationValueType

Internal computation type, for maintaining a desired precision

Definition at line 91 of file itkMultiStartOptimizerv4.h.

Definition at line 61 of file itkMultiStartOptimizerv4.h.

Definition at line 60 of file itkMultiStartOptimizerv4.h.

typedef Superclass::MeasureType itk::MultiStartOptimizerv4::MeasureType

Measure type

Definition at line 87 of file itkMultiStartOptimizerv4.h.

typedef Superclass::MetricType itk::MultiStartOptimizerv4::MetricType

Metric type over which this class is templated

Definition at line 80 of file itkMultiStartOptimizerv4.h.

typedef MetricType::Pointer itk::MultiStartOptimizerv4::MetricTypePointer

Definition at line 81 of file itkMultiStartOptimizerv4.h.

Definition at line 88 of file itkMultiStartOptimizerv4.h.

Definition at line 59 of file itkMultiStartOptimizerv4.h.

Definition at line 58 of file itkMultiStartOptimizerv4.h.

typedef ParametersListType::size_type itk::MultiStartOptimizerv4::ParameterListSizeType

Definition at line 57 of file itkMultiStartOptimizerv4.h.

Definition at line 56 of file itkMultiStartOptimizerv4.h.

typedef Superclass::ParametersType itk::MultiStartOptimizerv4::ParametersType

Definition at line 53 of file itkMultiStartOptimizerv4.h.

Definition at line 46 of file itkMultiStartOptimizerv4.h.

Standard class typedefs.

Definition at line 44 of file itkMultiStartOptimizerv4.h.

Stop condition internal string type

Definition at line 77 of file itkMultiStartOptimizerv4.h.

Stop condition return string type

Definition at line 74 of file itkMultiStartOptimizerv4.h.

Definition at line 45 of file itkMultiStartOptimizerv4.h.

Member Enumeration Documentation

Codes of stopping conditions.


Definition at line 64 of file itkMultiStartOptimizerv4.h.

Constructor & Destructor Documentation

itk::MultiStartOptimizerv4::MultiStartOptimizerv4 ( )

Default constructor

virtual itk::MultiStartOptimizerv4::~MultiStartOptimizerv4 ( )

Default constructor

itk::MultiStartOptimizerv4::MultiStartOptimizerv4 ( const Self )

Member Function Documentation

virtual::itk::LightObject::Pointer itk::MultiStartOptimizerv4::CreateAnother ( void  ) const

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.

ParametersType itk::MultiStartOptimizerv4::GetBestParameters ( )

Return the parameters from the best visited position

ParameterListSizeType itk::MultiStartOptimizerv4::GetBestParametersIndex ( )

Definition at line 139 of file itkMultiStartOptimizerv4.h.

virtual SizeValueType itk::MultiStartOptimizerv4::GetCurrentIteration ( ) const

Get the current iteration number.

virtual const OptimizerType* itk::MultiStartOptimizerv4::GetLocalOptimizer ( ) const

Set/Get the optimizer.

const MetricValuesListType& itk::MultiStartOptimizerv4::GetMetricValuesList ( ) const

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

virtual OptimizerType* itk::MultiStartOptimizerv4::GetModifiableLocalOptimizer ( )

Set/Get the optimizer.

virtual const char* itk::MultiStartOptimizerv4::GetNameOfClass ( ) const

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectOptimizerBase.

virtual const SizeValueType& itk::MultiStartOptimizerv4::GetNumberOfIterations ( )

Get the number of iterations.

ParametersListType& itk::MultiStartOptimizerv4::GetParametersList ( )

Get the list of parameters over which to search.

virtual const StopConditionType& itk::MultiStartOptimizerv4::GetStopCondition ( )

Get stop condition enum

virtual const StopConditionReturnStringType itk::MultiStartOptimizerv4::GetStopConditionDescription ( ) const

Get the reason for termination

void itk::MultiStartOptimizerv4::InstantiateLocalOptimizer ( void  )

Create an instance of the local optimizer

static Pointer itk::MultiStartOptimizerv4::New ( )

Method for creation through the object factory.

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

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

virtual void itk::MultiStartOptimizerv4::ResumeOptimization ( )

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

virtual void itk::MultiStartOptimizerv4::SetLocalOptimizer ( OptimizerType _arg)

Set/Get the optimizer.

virtual void itk::MultiStartOptimizerv4::SetNumberOfIterations ( SizeValueType  _arg)

Set the number of iterations.

void itk::MultiStartOptimizerv4::SetParametersList ( ParametersListType p)

Set the list of parameters over which to search

virtual void itk::MultiStartOptimizerv4::StartOptimization ( bool  doOnlyInitialization = false)

Begin the optimization

Reimplemented from itk::ObjectToObjectOptimizerBase.

virtual void itk::MultiStartOptimizerv4::StopOptimization ( void  )

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

Member Data Documentation

ParameterListSizeType itk::MultiStartOptimizerv4::m_BestParametersIndex

Definition at line 160 of file itkMultiStartOptimizerv4.h.

SizeValueType itk::MultiStartOptimizerv4::m_CurrentIteration

Definition at line 155 of file itkMultiStartOptimizerv4.h.

OptimizerPointer itk::MultiStartOptimizerv4::m_LocalOptimizer

Definition at line 161 of file itkMultiStartOptimizerv4.h.

MeasureType itk::MultiStartOptimizerv4::m_MaximumMetricValue

Definition at line 159 of file itkMultiStartOptimizerv4.h.

MetricValuesListType itk::MultiStartOptimizerv4::m_MetricValuesList

Definition at line 157 of file itkMultiStartOptimizerv4.h.

MeasureType itk::MultiStartOptimizerv4::m_MinimumMetricValue

Definition at line 158 of file itkMultiStartOptimizerv4.h.

SizeValueType itk::MultiStartOptimizerv4::m_NumberOfIterations

Definition at line 154 of file itkMultiStartOptimizerv4.h.

ParametersListType itk::MultiStartOptimizerv4::m_ParametersList

Definition at line 156 of file itkMultiStartOptimizerv4.h.

bool itk::MultiStartOptimizerv4::m_Stop

Definition at line 151 of file itkMultiStartOptimizerv4.h.

StopConditionType itk::MultiStartOptimizerv4::m_StopCondition

Definition at line 152 of file itkMultiStartOptimizerv4.h.

StopConditionDescriptionType itk::MultiStartOptimizerv4::m_StopConditionDescription

Definition at line 153 of file itkMultiStartOptimizerv4.h.

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