#include <itkOnePlusOneEvolutionaryOptimizerv4.h>

Detailed Description

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

1+1 evolutionary strategy optimizer

This optimizer searches for the optimal parameters. It changes its search radius and position using the grow factor ,shrink factor, and isotropic probability function (which is a random unit normal variate generator).

This optimizer needs a cost function and a random unit normal variate generator. The cost function should return cost with new position in parameter space which will be generated by 1+1 evolutionary strategy. Users should plug-in the random unit normal variate generator using SetNormalVariateGenerator method.

The SetEpsilon method is the minimum value for the frobenius_norm of the covariance matrix. If the fnorm is smaller than this value, the optimization process will stop even before it hits the maximum iteration.

Another way to stop the optimization process is calling the StopOptimization method. At next iteration after calling it, the optimization process will stop.

This optimizing scheme was initially developed and implemented by Martin Styner, Univ. of North Carolina at Chapel Hill, and his colleagues.

For more details refer to the following articles [113] and [112].

See also: NormalVariateGenerator

Examples: Examples/RegistrationITKv4/ImageRegistration11.cxx.

Definition at line 63 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

Inheritance diagram for itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >:

Collaboration diagram for itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	CostFunctionPointer = CostFunctionType::Pointer

using	CostFunctionType = SingleValuedCostFunctionv4

using	MeasureType

using	NormalVariateGeneratorType = Statistics::RandomVariateGeneratorBase

using	ParametersType

using	Pointer = SmartPointer<Self>

using	ScalesType

using	Self = OnePlusOneEvolutionaryOptimizerv4

using	Superclass = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>

Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
using	ConstPointer

using	ConstPointer

using	DerivativeType

using	DerivativeType

using	MeasureType

using	MeasureType

using	MetricType

using	MetricType

using	MetricTypePointer

using	MetricTypePointer

using	NumberOfParametersType

using	NumberOfParametersType

using	ParametersType

using	ParametersType

using	Pointer

using	Pointer

using	ScalesEstimatorType

using	ScalesEstimatorType

using	ScalesType

using	ScalesType

using	Self

using	Self

using	StopConditionDescriptionType

using	StopConditionDescriptionType

using	StopConditionReturnStringType

using	StopConditionReturnStringType

using	Superclass

using	Superclass

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

virtual void	CatchGetValueExceptionOn ()

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

virtual const bool &	GetCatchGetValueException () const

virtual const double &	GetFrobeniusNorm () const

virtual const bool &	GetInitialized () const

virtual const double &	GetMetricWorstPossibleValue () const

const char *	GetNameOfClass () const override

std::string	GetStopConditionDescription () const override

void	Initialize (double initialRadius, double grow=-1, double shrink=-1)

virtual void	SetCatchGetValueException (bool _arg)

virtual void	SetMetricWorstPossibleValue (double _arg)

void	SetNormalVariateGenerator (NormalVariateGeneratorType *generator)

void	StartOptimization (bool doOnlyInitialization=false) override

void	StopOptimization ()


virtual void	SetMaximumIteration (unsigned int _arg)

virtual const unsigned int &	GetMaximumIteration () const


virtual void	SetGrowthFactor (double _arg)

virtual const double &	GetGrowthFactor () const


virtual void	SetShrinkFactor (double _arg)

virtual const double &	GetShrinkFactor () const


virtual void	SetInitialRadius (double _arg)

virtual const double &	GetInitialRadius () const


virtual void	SetEpsilon (double _arg)

virtual const double &	GetEpsilon () const


virtual const MeasureType &	GetCurrentCost () const

const MeasureType &	GetValue () const override

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

virtual bool	CanUseScales () const

virtual SizeValueType	GetCurrentIteration () const

virtual SizeValueType	GetCurrentIteration () const

virtual const MeasureType &	GetCurrentMetricValue () const

virtual const MeasureType &	GetCurrentMetricValue () const

virtual const ParametersType &	GetCurrentPosition () const

virtual const ParametersType &	GetCurrentPosition () const

virtual SizeValueType	GetNumberOfIterations () const

virtual SizeValueType	GetNumberOfIterations () const

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetScales () const

virtual const bool &	GetScalesAreIdentity () const

virtual const bool &	GetScalesAreIdentity () const

bool	GetScalesInitialized () const

bool	GetScalesInitialized () const

virtual const ScalesType &	GetWeights () const

virtual const ScalesType &	GetWeights () const

virtual const bool &	GetWeightsAreIdentity () const

virtual const bool &	GetWeightsAreIdentity () const

virtual void	SetNumberOfIterations (SizeValueType _arg)

virtual void	SetNumberOfIterations (SizeValueType _arg)

virtual void	SetNumberOfWorkUnits (ThreadIdType number)

virtual void	SetNumberOfWorkUnits (ThreadIdType number)

virtual void	SetScalesEstimator (ScalesEstimatorType *_arg)

virtual void	SetScalesEstimator (ScalesEstimatorType *_arg)

virtual void	SetWeights (ScalesType _arg)

virtual void	SetWeights (ScalesType _arg)

virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual const MetricType *	GetMetric () const

virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual const MetricType *	GetMetric () const

virtual void	SetScales (const ScalesType &scales)

virtual void	SetScales (const ScalesType &scales)

virtual void	SetDoEstimateScales (bool _arg)

virtual const bool &	GetDoEstimateScales () const

virtual void	DoEstimateScalesOn ()

virtual void	DoEstimateScalesOff ()

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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

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

virtual int	GetReferenceCount () const

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

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

static Pointer	New ()

Protected Member Functions
	OnePlusOneEvolutionaryOptimizerv4 ()

	OnePlusOneEvolutionaryOptimizerv4 (const OnePlusOneEvolutionaryOptimizerv4 &)

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

	~OnePlusOneEvolutionaryOptimizerv4 () override=default

Protected Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
	ObjectToObjectOptimizerBaseTemplate ()

	ObjectToObjectOptimizerBaseTemplate ()

	~ObjectToObjectOptimizerBaseTemplate () override

	~ObjectToObjectOptimizerBaseTemplate () override

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

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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
bool	m_CatchGetValueException {}

MeasureType	m_CurrentCost {}

double	m_Epsilon {}

double	m_FrobeniusNorm {}

double	m_GrowthFactor {}

bool	m_Initialized {}

double	m_InitialRadius {}

unsigned int	m_MaximumIteration {}

double	m_MetricWorstPossibleValue {}

NormalVariateGeneratorType::Pointer	m_RandomGenerator {}

double	m_ShrinkFactor {}

bool	m_Stop {}

std::ostringstream	m_StopConditionDescription {}

Additional Inherited Members
Protected Attributes inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
SizeValueType	m_CurrentIteration

SizeValueType	m_CurrentIteration

MeasureType	m_CurrentMetricValue

MeasureType	m_CurrentMetricValue

bool	m_DoEstimateScales

bool	m_DoEstimateScales

MetricTypePointer	m_Metric

MetricTypePointer	m_Metric

SizeValueType	m_NumberOfIterations

SizeValueType	m_NumberOfIterations

ThreadIdType	m_NumberOfWorkUnits

ThreadIdType	m_NumberOfWorkUnits

ScalesType	m_Scales

ScalesType	m_Scales

bool	m_ScalesAreIdentity

bool	m_ScalesAreIdentity

ScalesEstimatorType::Pointer	m_ScalesEstimator

ScalesEstimatorType::Pointer	m_ScalesEstimator

ScalesType	m_Weights

ScalesType	m_Weights

bool	m_WeightsAreIdentity

bool	m_WeightsAreIdentity

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInternalComputationValueType>

using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 71 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ CostFunctionPointer

template<typename TInternalComputationValueType>

using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::CostFunctionPointer = CostFunctionType::Pointer

Definition at line 81 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ CostFunctionType

template<typename TInternalComputationValueType>

using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::CostFunctionType = SingleValuedCostFunctionv4

Type of the Cost Function

Definition at line 80 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ MeasureType

template<typename TInternalComputationValueType>

using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::MeasureType

Measure type

Definition at line 145 of file itkObjectToObjectOptimizerBase.h.

◆ NormalVariateGeneratorType

template<typename TInternalComputationValueType>

using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::NormalVariateGeneratorType = Statistics::RandomVariateGeneratorBase

Normal random variate generator type.

Definition at line 84 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ ParametersType

template<typename TInternalComputationValueType>

using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ParametersType

Parameters type.

Definition at line 132 of file itkObjectToObjectOptimizerBase.h.

◆ Pointer

template<typename TInternalComputationValueType>

using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 70 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ ScalesType

template<typename TInternalComputationValueType>

using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ScalesType

Scale type.

Definition at line 128 of file itkObjectToObjectOptimizerBase.h.

◆ Self

template<typename TInternalComputationValueType>

using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Self = OnePlusOneEvolutionaryOptimizerv4

Standard "Self" type alias.

Definition at line 68 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ Superclass

template<typename TInternalComputationValueType>

using itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Superclass = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>

Definition at line 69 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

Constructor & Destructor Documentation

◆ OnePlusOneEvolutionaryOptimizerv4() [1/2]

template<typename TInternalComputationValueType>

itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::OnePlusOneEvolutionaryOptimizerv4 ( )

protected

Referenced by GetNameOfClass(), and OnePlusOneEvolutionaryOptimizerv4().

◆ OnePlusOneEvolutionaryOptimizerv4() [2/2]

template<typename TInternalComputationValueType>

itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::OnePlusOneEvolutionaryOptimizerv4 ( const OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType > & )

protected

References OnePlusOneEvolutionaryOptimizerv4().

◆ ~OnePlusOneEvolutionaryOptimizerv4()

template<typename TInternalComputationValueType>

itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::~OnePlusOneEvolutionaryOptimizerv4 ( )

overrideprotecteddefault

Member Function Documentation

◆ CatchGetValueExceptionOff()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::CatchGetValueExceptionOff ( )

virtual

◆ CatchGetValueExceptionOn()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::CatchGetValueExceptionOn ( )

virtual

◆ CreateAnother()

template<typename TInternalComputationValueType>

virtual::itk::LightObject::Pointer itk::OnePlusOneEvolutionaryOptimizerv4< 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.

◆ GetCatchGetValueException()

template<typename TInternalComputationValueType>

virtual const bool & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetCatchGetValueException ( ) const

virtual

◆ GetCurrentCost()

template<typename TInternalComputationValueType>

virtual const MeasureType & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetCurrentCost ( ) const

virtual

Return Current Value

◆ GetEpsilon()

template<typename TInternalComputationValueType>

virtual const double & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetEpsilon ( ) const

virtual

Set/Get the minimal size of search radius (frobenius_norm of covariance matrix).

◆ GetFrobeniusNorm()

template<typename TInternalComputationValueType>

virtual const double & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetFrobeniusNorm ( ) const

virtual

Get the current Frobenius norm of covariance matrix

◆ GetGrowthFactor()

template<typename TInternalComputationValueType>

virtual const double & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetGrowthFactor ( ) const

virtual

Set/Get the search radius grow factor in parameter space.

◆ GetInitialized()

template<typename TInternalComputationValueType>

virtual const bool & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetInitialized ( ) const

virtual

Return if optimizer has been initialized

◆ GetInitialRadius()

template<typename TInternalComputationValueType>

virtual const double & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetInitialRadius ( ) const

virtual

Set/Get initial search radius in parameter space

◆ GetMaximumIteration()

template<typename TInternalComputationValueType>

virtual const unsigned int & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetMaximumIteration ( ) const

virtual

Set/Get maximum iteration limit.

◆ GetMetricWorstPossibleValue()

template<typename TInternalComputationValueType>

virtual const double & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetMetricWorstPossibleValue ( ) const

virtual

◆ GetNameOfClass()

template<typename TInternalComputationValueType>

const char * itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

References OnePlusOneEvolutionaryOptimizerv4().

◆ GetShrinkFactor()

template<typename TInternalComputationValueType>

virtual const double & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetShrinkFactor ( ) const

virtual

Set/Get the search radius shrink factor.

◆ GetStopConditionDescription()

template<typename TInternalComputationValueType>

std::string itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetStopConditionDescription ( ) const

overridevirtual

Stop condition return string type

Implements itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

◆ GetValue()

template<typename TInternalComputationValueType>

const MeasureType & itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::GetValue ( ) const

overridevirtual

Return Current Value

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

◆ Initialize()

template<typename TInternalComputationValueType>

void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::Initialize	(	double	initialRadius,
		double	grow = -1,
		double	shrink = -1 )

Initializes the optimizer. Before running this optimizer, this function should have been called.

initialRadius: search radius in parameter space grow: search radius grow factor shrink: search radius shrink factor

◆ New()

template<typename TInternalComputationValueType>

static Pointer itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInternalComputationValueType>

void itk::OnePlusOneEvolutionaryOptimizerv4< 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 >.

◆ SetCatchGetValueException()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetCatchGetValueException ( bool _arg )

virtual

◆ SetEpsilon()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetEpsilon ( double _arg )

virtual

Set/Get the minimal size of search radius (frobenius_norm of covariance matrix).

◆ SetGrowthFactor()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetGrowthFactor ( double _arg )

virtual

Set/Get the search radius grow factor in parameter space.

◆ SetInitialRadius()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetInitialRadius ( double _arg )

virtual

Set/Get initial search radius in parameter space

◆ SetMaximumIteration()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetMaximumIteration ( unsigned int _arg )

virtual

Set/Get maximum iteration limit.

◆ SetMetricWorstPossibleValue()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetMetricWorstPossibleValue ( double _arg )

virtual

◆ SetNormalVariateGenerator()

template<typename TInternalComputationValueType>

void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetNormalVariateGenerator ( NormalVariateGeneratorType * generator )

◆ SetShrinkFactor()

template<typename TInternalComputationValueType>

virtual void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::SetShrinkFactor ( double _arg )

virtual

Set/Get the search radius shrink factor.

◆ StartOptimization()

template<typename TInternalComputationValueType>

void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::StartOptimization ( bool doOnlyInitialization = false )

overridevirtual

Start optimization. Optimization will stop when it meets either of two termination conditions, the maximum iteration limit or epsilon (minimal search radius)

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

◆ StopOptimization()

template<typename TInternalComputationValueType>

void itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::StopOptimization ( )

inline

when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.

Definition at line 155 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

References m_Stop.

Member Data Documentation

◆ m_CatchGetValueException

template<typename TInternalComputationValueType>

bool itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_CatchGetValueException {}

private

Definition at line 184 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_CurrentCost

template<typename TInternalComputationValueType>

MeasureType itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_CurrentCost {}

private

Internal storage for the value type / used as a cache

Definition at line 204 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_Epsilon

template<typename TInternalComputationValueType>

double itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_Epsilon {}

private

The minimal size of search radius (frobenius_norm of covariance matrix).

Definition at line 189 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_FrobeniusNorm

template<typename TInternalComputationValueType>

double itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_FrobeniusNorm {}

private

Cache variable for reporting the Frobenius Norm

Definition at line 217 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_GrowthFactor

template<typename TInternalComputationValueType>

double itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_GrowthFactor {}

private

Search radius growth factor in parameter space.

Definition at line 195 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_Initialized

template<typename TInternalComputationValueType>

bool itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_Initialized {}

private

Flag tells if the optimizer was initialized using Initialize function.

Definition at line 201 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_InitialRadius

template<typename TInternalComputationValueType>

double itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_InitialRadius {}

private

Initial search radius in parameter space.

Definition at line 192 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_MaximumIteration

template<typename TInternalComputationValueType>

unsigned int itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_MaximumIteration {}

private

Maximum iteration limit.

Definition at line 182 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_MetricWorstPossibleValue

template<typename TInternalComputationValueType>

double itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_MetricWorstPossibleValue {}

private

Definition at line 185 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_RandomGenerator

template<typename TInternalComputationValueType>

NormalVariateGeneratorType::Pointer itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_RandomGenerator {}

private

Smart pointer to the normal random variate generator.

Definition at line 179 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_ShrinkFactor

template<typename TInternalComputationValueType>

double itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_ShrinkFactor {}

private

Search radius shrink factor in parameter space,

Definition at line 198 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

◆ m_Stop

template<typename TInternalComputationValueType>

bool itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_Stop {}

private

This is user-settable flag to stop optimization. when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.

Definition at line 210 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

Referenced by StopOptimization().

◆ m_StopConditionDescription

template<typename TInternalComputationValueType>

std::ostringstream itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >::m_StopConditionDescription {}

private

Stop description

Definition at line 213 of file itkOnePlusOneEvolutionaryOptimizerv4.h.

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

itkOnePlusOneEvolutionaryOptimizerv4.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CostFunctionPointer

◆ CostFunctionType

◆ MeasureType

◆ NormalVariateGeneratorType

◆ ParametersType

◆ Pointer

◆ ScalesType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ OnePlusOneEvolutionaryOptimizerv4() [1/2]

◆ OnePlusOneEvolutionaryOptimizerv4() [2/2]

◆ ~OnePlusOneEvolutionaryOptimizerv4()

Member Function Documentation

◆ CatchGetValueExceptionOff()

◆ CatchGetValueExceptionOn()

◆ CreateAnother()

◆ GetCatchGetValueException()

◆ GetCurrentCost()

◆ GetEpsilon()

◆ GetFrobeniusNorm()

◆ GetGrowthFactor()

◆ GetInitialized()

◆ GetInitialRadius()

◆ GetMaximumIteration()

◆ GetMetricWorstPossibleValue()

◆ GetNameOfClass()

◆ GetShrinkFactor()

◆ GetStopConditionDescription()

◆ GetValue()

◆ Initialize()

◆ New()

◆ PrintSelf()

◆ SetCatchGetValueException()

◆ SetEpsilon()

◆ SetGrowthFactor()

◆ SetInitialRadius()

◆ SetMaximumIteration()

◆ SetMetricWorstPossibleValue()

◆ SetNormalVariateGenerator()

◆ SetShrinkFactor()

◆ StartOptimization()

◆ StopOptimization()

Member Data Documentation

◆ m_CatchGetValueException

◆ m_CurrentCost

◆ m_Epsilon

◆ m_FrobeniusNorm

◆ m_GrowthFactor

◆ m_Initialized

◆ m_InitialRadius

◆ m_MaximumIteration

◆ m_MetricWorstPossibleValue

◆ m_RandomGenerator

◆ m_ShrinkFactor

◆ m_Stop

◆ m_StopConditionDescription