#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 Self >	ConstPointer

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< MeasureType >	MetricValuesListType

typedef OptimizerType::Pointer	OptimizerPointer

typedef ObjectToObjectOptimizerBaseTemplate < TInternalComputationValueType >	OptimizerType

typedef ParametersListType::size_type	ParameterListSizeType

typedef std::vector < ParametersType >	ParametersListType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

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 Self >	ConstPointer

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< Self >	Pointer

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 Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

ParametersType	GetBestParameters ()

ParameterListSizeType	GetBestParametersIndex ()

const MetricValuesListType &	GetMetricValuesList () const

virtual const char *	GetNameOfClass () const

ParametersListType &	GetParametersList ()

virtual const StopConditionType &	GetStopCondition () 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 OptimizerType *	GetModifiableLocalOptimizer ()

virtual const OptimizerType *	GetLocalOptimizer () const

Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
virtual SizeValueType	GetCurrentIteration () const

virtual const MeasureType &	GetCurrentMetricValue () const

virtual const ParametersType &	GetCurrentPosition () const

virtual SizeValueType	GetNumberOfIterations () const

virtual const ThreadIdType &	GetNumberOfThreads () const

virtual const ScalesType &	GetScales () const

virtual const bool &	GetScalesAreIdentity () const

bool	GetScalesInitialized () const

virtual const MeasureType &	GetValue () const

virtual const ScalesType &	GetWeights () 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 MetricType *	GetModifiableMetric ()

virtual const MetricType *	GetMetric () 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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 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