#include <itkMultiStartOptimizerv4.h>

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

Inheritance diagram for itk::MultiStartOptimizerv4Template< TInternalComputationValueType >:

Collaboration diagram for itk::MultiStartOptimizerv4Template< TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename MetricType::DerivativeType

using	InternalComputationValueType = TInternalComputationValueType

using	LocalOptimizerPointer = typename LocalOptimizerType::Pointer

using	LocalOptimizerType = typename itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >

using	MetricTypePointer = typename MetricType::Pointer

using	MetricValuesListType = std::vector< MeasureType >

using	OptimizerPointer = typename OptimizerType::Pointer

using	OptimizerType = ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >

using	ParameterListSizeType = typename ParametersListType::size_type

using	ParametersListType = std::vector< ParametersType >

using	Pointer = SmartPointer< Self >

using	Self = MultiStartOptimizerv4Template

using	Superclass = ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >

Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename MetricType::DerivativeType

using	MeasureType = typename MetricType::MeasureType

using	MetricType = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >

using	MetricTypePointer = typename MetricType::Pointer

using	NumberOfParametersType = typename MetricType::NumberOfParametersType

using	ParametersType = OptimizerParameters< TInternalComputationValueType >

using	Pointer = SmartPointer< Self >

using	ScalesEstimatorType = OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >

using	ScalesType = OptimizerParameters< TInternalComputationValueType >

using	Self = ObjectToObjectOptimizerBaseTemplate

using	StopConditionDescriptionType = std::ostringstream

using	StopConditionReturnStringType = std::string

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
ParametersType	GetBestParameters ()

ParameterListSizeType	GetBestParametersIndex ()

const MetricValuesListType &	GetMetricValuesList () const

const char *	GetNameOfClass () const override

ParametersListType &	GetParametersList ()

virtual const StopConditionObjectToObjectOptimizerEnum &	GetStopCondition () const

StopConditionReturnStringType	GetStopConditionDescription () const override

void	InstantiateLocalOptimizer ()

virtual void	ResumeOptimization ()

void	SetParametersList (ParametersListType &p)

void	StartOptimization (bool doOnlyInitialization=false) override

virtual void	StopOptimization ()


virtual void	SetLocalOptimizer (OptimizerType *_arg)

virtual OptimizerType *	GetModifiableLocalOptimizer ()

Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
virtual bool	CanUseScales () const

virtual SizeValueType	GetCurrentIteration () const

virtual const MeasureType &	GetCurrentMetricValue () const

virtual const ParametersType &	GetCurrentPosition () const

const char *	GetNameOfClass () const override

virtual SizeValueType	GetNumberOfIterations () const

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

virtual const ScalesType &	GetScales () const

virtual const bool &	GetScalesAreIdentity () const

bool	GetScalesInitialized () const

virtual StopConditionReturnStringType	GetStopConditionDescription () const=0

virtual const MeasureType &	GetValue () const

virtual const ScalesType &	GetWeights () const

virtual const bool &	GetWeightsAreIdentity () const

virtual void	SetNumberOfIterations (SizeValueType _arg)

virtual void	SetNumberOfWorkUnits (ThreadIdType number)

virtual void	SetScalesEstimator (ScalesEstimatorType *_arg)

virtual void	SetWeights (ScalesType _arg)

virtual void	StartOptimization (bool doOnlyInitialization=false)

virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual void	SetScales (const ScalesType &scales)

virtual void	SetDoEstimateScales (bool _arg)

virtual const bool &	GetDoEstimateScales () const

virtual void	DoEstimateScalesOn ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override


	MultiStartOptimizerv4Template ()

	~MultiStartOptimizerv4Template () override=default

Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
void	PrintSelf (std::ostream &os, Indent indent) const override

	ObjectToObjectOptimizerBaseTemplate ()

	~ObjectToObjectOptimizerBaseTemplate () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (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 { false }

StopConditionObjectToObjectOptimizerEnum	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_NumberOfWorkUnits

ScalesType	m_Scales

bool	m_ScalesAreIdentity

ScalesEstimatorType::Pointer	m_ScalesEstimator

ScalesType	m_Weights

bool	m_WeightsAreIdentity

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}