itk::MultiStartOptimizerv4 Class Reference

#include <itkMultiStartOptimizerv4.h>

Inheritance diagram for itk::MultiStartOptimizerv4:

Collaboration diagram for itk::MultiStartOptimizerv4:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef MetricType::DerivativeType	DerivativeType
typedef Superclass::InternalComputationValueType	InternalComputationValueType
typedef itk::GradientDescentOptimizerv4::Pointer	LocalOptimizerPointer
typedef itk::GradientDescentOptimizerv4	LocalOptimizerType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MetricType	MetricType
typedef MetricType::Pointer	MetricTypePointer
typedef std::vector< MeasureType >	MetricValuesListType
typedef OptimizerType::Pointer	OptimizerPointer
typedef ObjectToObjectOptimizerBase	OptimizerType
typedef ParametersListType::size_type	ParameterListSizeType
typedef std::vector < ParametersType >	ParametersListType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef MultiStartOptimizerv4	Self
typedef std::ostringstream	StopConditionDescriptionType
typedef std::string	StopConditionReturnStringType
enum	StopConditionType {   MAXIMUM_NUMBER_OF_ITERATIONS,   COSTFUNCTION_ERROR,   UPDATE_PARAMETERS_ERROR,   STEP_TOO_SMALL,   CONVERGENCE_CHECKER_PASSED,   OTHER_ERROR }
typedef ObjectToObjectOptimizerBase	Superclass
Public Types inherited from itk::ObjectToObjectOptimizerBase
typedef MetricType::NumberOfParametersType	NumberOfParametersType
typedef OptimizerParameters < double >	ScalesType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
ParametersType	GetBestParameters ()
ParameterListSizeType	GetBestParametersIndex ()
virtual SizeValueType	GetCurrentIteration () const
const MetricValuesListType &	GetMetricValuesList () const
virtual const char *	GetNameOfClass () const
virtual const SizeValueType &	GetNumberOfIterations ()
ParametersListType &	GetParametersList ()
virtual const StopConditionType &	GetStopCondition ()
virtual const StopConditionReturnStringType	GetStopConditionDescription () const
void	InstantiateLocalOptimizer (void)
virtual void	ResumeOptimization ()
virtual void	SetNumberOfIterations (SizeValueType _arg)
void	SetParametersList (ParametersListType &p)
virtual void	StartOptimization (void)
virtual void	StopOptimization (void)
virtual void	SetLocalOptimizer (OptimizerType *_arg)
virtual OptimizerType *	GetLocalOptimizer ()
Public Member Functions inherited from itk::ObjectToObjectOptimizerBase
virtual const MeasureType &	GetCurrentMetricValue ()
const ParametersType &	GetCurrentPosition ()
virtual const ThreadIdType &	GetNumberOfThreads ()
virtual const ScalesType &	GetScales ()
virtual const bool &	GetScalesAreIdentity ()
const MeasureType &	GetValue ()
virtual void	SetNumberOfThreads (ThreadIdType number)
virtual void	SetScales (ScalesType _arg)
virtual MetricType *	GetMetric ()
virtual void	SetMetric (MetricType *_arg)
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
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

Private Member Functions
	MultiStartOptimizerv4 (const Self &)
void	operator= (const Self &)

---

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.

---

Member Typedef Documentation

typedef SmartPointer< const Self > itk::MultiStartOptimizerv4::ConstPointer

Reimplemented from itk::ObjectToObjectOptimizerBase.

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

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 91 of file itkMultiStartOptimizerv4.h.

typedef itk::GradientDescentOptimizerv4::Pointer itk::MultiStartOptimizerv4::LocalOptimizerPointer

Definition at line 61 of file itkMultiStartOptimizerv4.h.

typedef itk::GradientDescentOptimizerv4 itk::MultiStartOptimizerv4::LocalOptimizerType

Definition at line 60 of file itkMultiStartOptimizerv4.h.

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

Measure type

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 87 of file itkMultiStartOptimizerv4.h.

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

Metric type over which this class is templated

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 80 of file itkMultiStartOptimizerv4.h.

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

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 81 of file itkMultiStartOptimizerv4.h.

typedef std::vector< MeasureType > itk::MultiStartOptimizerv4::MetricValuesListType

Definition at line 88 of file itkMultiStartOptimizerv4.h.

typedef OptimizerType::Pointer itk::MultiStartOptimizerv4::OptimizerPointer

Definition at line 59 of file itkMultiStartOptimizerv4.h.

typedef ObjectToObjectOptimizerBase itk::MultiStartOptimizerv4::OptimizerType

Definition at line 58 of file itkMultiStartOptimizerv4.h.

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

Definition at line 57 of file itkMultiStartOptimizerv4.h.

typedef std::vector< ParametersType > itk::MultiStartOptimizerv4::ParametersListType

Definition at line 56 of file itkMultiStartOptimizerv4.h.

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

Parameters type.

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 53 of file itkMultiStartOptimizerv4.h.

typedef SmartPointer< Self > itk::MultiStartOptimizerv4::Pointer

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 46 of file itkMultiStartOptimizerv4.h.

typedef MultiStartOptimizerv4 itk::MultiStartOptimizerv4::Self

Standard class typedefs.

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 44 of file itkMultiStartOptimizerv4.h.

typedef std::ostringstream itk::MultiStartOptimizerv4::StopConditionDescriptionType

Stop condition internal string type

Definition at line 77 of file itkMultiStartOptimizerv4.h.

typedef std::string itk::MultiStartOptimizerv4::StopConditionReturnStringType

Stop condition return string type

Definition at line 74 of file itkMultiStartOptimizerv4.h.

typedef ObjectToObjectOptimizerBase itk::MultiStartOptimizerv4::Superclass

Reimplemented from itk::ObjectToObjectOptimizerBase.

Definition at line 45 of file itkMultiStartOptimizerv4.h.

---

Member Enumeration Documentation

enum itk::MultiStartOptimizerv4::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 64 of file itkMultiStartOptimizerv4.h.

---

Constructor & Destructor Documentation

itk::MultiStartOptimizerv4::MultiStartOptimizerv4 ( )

protected

Default constructor

virtual itk::MultiStartOptimizerv4::~MultiStartOptimizerv4 ( )

protectedvirtual

Default constructor

itk::MultiStartOptimizerv4::MultiStartOptimizerv4 ( const Self &  )

private

---

Member Function Documentation

virtual::itk::LightObject::Pointer itk::MultiStartOptimizerv4::CreateAnother ( void  ) 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.

ParametersType itk::MultiStartOptimizerv4::GetBestParameters

(

)

Return the parameters from the best visited position

ParameterListSizeType itk::MultiStartOptimizerv4::GetBestParametersIndex ( )

inline

Definition at line 139 of file itkMultiStartOptimizerv4.h.

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

virtual

Get the current iteration number.

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

virtual

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 const char* itk::MultiStartOptimizerv4::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectOptimizerBase.

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

virtual

Get the number of iterations.

ParametersListType& itk::MultiStartOptimizerv4::GetParametersList

(

)

Get the list of parameters over which to search.

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

virtual

Get stop condition enum

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

virtual

Get the reason for termination

void itk::MultiStartOptimizerv4::InstantiateLocalOptimizer

(

void

)

Create an instance of the local optimizer

static Pointer itk::MultiStartOptimizerv4::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

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

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::ObjectToObjectOptimizerBase.

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

protectedvirtual

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 ( )

virtual

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 )

virtual

Set/Get the optimizer.

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

virtual

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 ( void  )

virtual

Begin the optimization

Reimplemented from itk::ObjectToObjectOptimizerBase.

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

virtual

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

protected

Definition at line 160 of file itkMultiStartOptimizerv4.h.

SizeValueType itk::MultiStartOptimizerv4::m_CurrentIteration

protected

Definition at line 155 of file itkMultiStartOptimizerv4.h.

OptimizerPointer itk::MultiStartOptimizerv4::m_LocalOptimizer

protected

Definition at line 161 of file itkMultiStartOptimizerv4.h.

MeasureType itk::MultiStartOptimizerv4::m_MaximumMetricValue

protected

Definition at line 159 of file itkMultiStartOptimizerv4.h.

MetricValuesListType itk::MultiStartOptimizerv4::m_MetricValuesList

protected

Definition at line 157 of file itkMultiStartOptimizerv4.h.

MeasureType itk::MultiStartOptimizerv4::m_MinimumMetricValue

protected

Definition at line 158 of file itkMultiStartOptimizerv4.h.

SizeValueType itk::MultiStartOptimizerv4::m_NumberOfIterations

protected

Definition at line 154 of file itkMultiStartOptimizerv4.h.

ParametersListType itk::MultiStartOptimizerv4::m_ParametersList

protected

Definition at line 156 of file itkMultiStartOptimizerv4.h.

bool itk::MultiStartOptimizerv4::m_Stop

protected

Definition at line 151 of file itkMultiStartOptimizerv4.h.

StopConditionType itk::MultiStartOptimizerv4::m_StopCondition

protected

Definition at line 152 of file itkMultiStartOptimizerv4.h.

StopConditionDescriptionType itk::MultiStartOptimizerv4::m_StopConditionDescription

protected

Definition at line 153 of file itkMultiStartOptimizerv4.h.

---

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

• itkMultiStartOptimizerv4.h