#include <itkOnePlusOneEvolutionaryOptimizer.h>

Inheritance diagram for itk::OnePlusOneEvolutionaryOptimizer:

Collaboration diagram for itk::OnePlusOneEvolutionaryOptimizer:

Detailed Description

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. "Parametric estimate of intensity inhomogeneities applied to MRI" Martin Styner, G. Gerig, Christian Brechbuehler, Gabor Szekely, IEEE TRANSACTIONS ON MEDICAL IMAGING; 19(3), pp. 153-165, 2000, (http://www.cs.unc.edu/~styner/docs/tmi00.pdf)

"Evaluation of 2D/3D bias correction with 1+1ES-optimization" Martin Styner, Prof. Dr. G. Gerig (IKT, BIWI, ETH Zuerich), TR-197 (http://www.cs.unc.edu/~styner/docs/StynerTR97.pdf)

See Also: NormalVariateGenerator

Examples:: Examples/RegistrationITKv3/ImageRegistration11.cxx, Examples/RegistrationITKv3/ImageRegistration14.cxx, Examples/RegistrationITKv3/ImageRegistration15.cxx, Examples/RegistrationITKv3/ModelToImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration14.cxx, Examples/RegistrationITKv4/ImageRegistration15.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, and Examples/Segmentation/GeodesicActiveContourShapePriorLevelSetImageFilter.cxx.

Definition at line 71 of file itkOnePlusOneEvolutionaryOptimizer.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CostFunctionPointer = CostFunctionType::Pointer

using	CostFunctionType = SingleValuedCostFunction

using	NormalVariateGeneratorType = Statistics::RandomVariateGeneratorBase

using	Pointer = SmartPointer< Self >

using	Self = OnePlusOneEvolutionaryOptimizer

using	Superclass = SingleValuedNonLinearOptimizer

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

using	CostFunctionPointer = CostFunctionType::Pointer

using	CostFunctionType = SingleValuedCostFunction

using	DerivativeType = CostFunctionType::DerivativeType

using	MeasureType = CostFunctionType::MeasureType

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = SingleValuedNonLinearOptimizer

using	Superclass = NonLinearOptimizer

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

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = Superclass::ScalesType

using	Self = NonLinearOptimizer

using	Superclass = Optimizer

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

using	ParametersType = OptimizerParameters< double >

using	Pointer = SmartPointer< Self >

using	ScalesType = Array< double >

using	Self = Optimizer

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

virtual const bool &	GetCatchGetValueException () const

virtual const unsigned int &	GetCurrentIteration () const

virtual const double &	GetFrobeniusNorm () const

virtual const bool &	GetInitialized () const

virtual const double &	GetMetricWorstPossibleValue () const

bool	GetMinimize () const

virtual const char *	GetNameOfClass () const

const std::string	GetStopConditionDescription () const override

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

void	MinimizeOff ()

void	MinimizeOn ()

virtual void	SetCatchGetValueException (bool _arg)

virtual void	SetMetricWorstPossibleValue (double _arg)

void	SetMinimize (bool v)

void	SetNormalVariateGenerator (NormalVariateGeneratorType *generator)

void	StartOptimization () override

void	StopOptimization ()


virtual void	SetMaximize (bool _arg)

virtual void	MaximizeOn ()

virtual void	MaximizeOff ()

virtual const bool &	GetMaximize () const


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

MeasureType	GetValue () const

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

virtual const CostFunctionType *	GetCostFunction () const

virtual CostFunctionType *	GetModifiableCostFunction ()

MeasureType	GetValue (const ParametersType &parameters) const

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetCurrentPosition () const

virtual const ParametersType &	GetInitialPosition () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () 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

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)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

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
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::SingleValuedNonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::Optimizer
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
	OnePlusOneEvolutionaryOptimizer ()

	OnePlusOneEvolutionaryOptimizer (const OnePlusOneEvolutionaryOptimizer &)

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

	~OnePlusOneEvolutionaryOptimizer () override=default

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

	SingleValuedNonLinearOptimizer ()

	~SingleValuedNonLinearOptimizer () override=default

Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()=default

	~NonLinearOptimizer () override

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

virtual void	SetCurrentPosition (const ParametersType &param)

	~Optimizer () override=default

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

	~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

unsigned int	m_CurrentIteration

double	m_Epsilon

double	m_FrobeniusNorm

double	m_GrowthFactor

bool	m_Initialized

double	m_InitialRadius

bool	m_Maximize

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::SingleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction

Protected Attributes inherited from itk::Optimizer
ParametersType	m_CurrentPosition

bool	m_ScalesInitialized { false }

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

Member Typedef Documentation

using itk::OnePlusOneEvolutionaryOptimizer::ConstPointer = SmartPointer< const Self >

Definition at line 79 of file itkOnePlusOneEvolutionaryOptimizer.h.

using itk::OnePlusOneEvolutionaryOptimizer::CostFunctionPointer = CostFunctionType::Pointer

Definition at line 89 of file itkOnePlusOneEvolutionaryOptimizer.h.

using itk::OnePlusOneEvolutionaryOptimizer::CostFunctionType = SingleValuedCostFunction

Type of the Cost Function

Definition at line 88 of file itkOnePlusOneEvolutionaryOptimizer.h.

using itk::OnePlusOneEvolutionaryOptimizer::NormalVariateGeneratorType = Statistics::RandomVariateGeneratorBase

Normal random variate generator type.

Definition at line 92 of file itkOnePlusOneEvolutionaryOptimizer.h.

using itk::OnePlusOneEvolutionaryOptimizer::Pointer = SmartPointer< Self >

Definition at line 78 of file itkOnePlusOneEvolutionaryOptimizer.h.

using itk::OnePlusOneEvolutionaryOptimizer::Self = OnePlusOneEvolutionaryOptimizer

Standard "Self" type alias.

Definition at line 76 of file itkOnePlusOneEvolutionaryOptimizer.h.

using itk::OnePlusOneEvolutionaryOptimizer::Superclass = SingleValuedNonLinearOptimizer

Definition at line 77 of file itkOnePlusOneEvolutionaryOptimizer.h.

Constructor & Destructor Documentation

itk::OnePlusOneEvolutionaryOptimizer::OnePlusOneEvolutionaryOptimizer ( )

protected

itk::OnePlusOneEvolutionaryOptimizer::OnePlusOneEvolutionaryOptimizer ( const OnePlusOneEvolutionaryOptimizer & )

protected

itk::OnePlusOneEvolutionaryOptimizer::~OnePlusOneEvolutionaryOptimizer ( )

overrideprotecteddefault

Member Function Documentation

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

virtual const bool& itk::OnePlusOneEvolutionaryOptimizer::GetCatchGetValueException ( ) const

virtual

virtual const MeasureType& itk::OnePlusOneEvolutionaryOptimizer::GetCurrentCost ( ) const

virtual

Return Current Value

virtual const unsigned int& itk::OnePlusOneEvolutionaryOptimizer::GetCurrentIteration ( ) const

virtual

Return Current Iteration

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetEpsilon ( ) const

virtual

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

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetFrobeniusNorm ( ) const

virtual

Get the current Frobenius norm of covariance matrix

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetGrowthFactor ( ) const

virtual

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

virtual const bool& itk::OnePlusOneEvolutionaryOptimizer::GetInitialized ( ) const

virtual

Return if optimizer has been initialized

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetInitialRadius ( ) const

virtual

Set/Get initial search radius in parameter space

virtual const bool& itk::OnePlusOneEvolutionaryOptimizer::GetMaximize ( ) const

virtual

Set if the Optimizer should Maximize the metric

virtual const unsigned int& itk::OnePlusOneEvolutionaryOptimizer::GetMaximumIteration ( ) const

virtual

Set/Get maximum iteration limit.

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetMetricWorstPossibleValue ( ) const

virtual

bool itk::OnePlusOneEvolutionaryOptimizer::GetMinimize ( ) const

inline

Definition at line 100 of file itkOnePlusOneEvolutionaryOptimizer.h.

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

virtual const double& itk::OnePlusOneEvolutionaryOptimizer::GetShrinkFactor ( ) const

virtual

Set/Get the search radius shrink factor.

const std::string itk::OnePlusOneEvolutionaryOptimizer::GetStopConditionDescription ( ) const

overridevirtual

Get the reason for termination

Reimplemented from itk::Optimizer.

MeasureType itk::OnePlusOneEvolutionaryOptimizer::GetValue ( ) const

inline

Return Current Value

Definition at line 150 of file itkOnePlusOneEvolutionaryOptimizer.h.

void itk::OnePlusOneEvolutionaryOptimizer::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: searhc radius shrink factor

virtual void itk::OnePlusOneEvolutionaryOptimizer::MaximizeOff ( )

virtual

Set if the Optimizer should Maximize the metric

virtual void itk::OnePlusOneEvolutionaryOptimizer::MaximizeOn ( )

virtual

Set if the Optimizer should Maximize the metric

void itk::OnePlusOneEvolutionaryOptimizer::MinimizeOff ( )

inline

Definition at line 106 of file itkOnePlusOneEvolutionaryOptimizer.h.

void itk::OnePlusOneEvolutionaryOptimizer::MinimizeOn ( )

inline

Definition at line 104 of file itkOnePlusOneEvolutionaryOptimizer.h.

static Pointer itk::OnePlusOneEvolutionaryOptimizer::New ( )

static

Method for creation through the object factory.

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

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetCatchGetValueException ( bool _arg )

virtual

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetEpsilon ( double _arg )

virtual

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

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetGrowthFactor ( double _arg )

virtual

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

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetInitialRadius ( double _arg )

virtual

Set/Get initial search radius in parameter space

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetMaximize ( bool _arg )

virtual

Set if the Optimizer should Maximize the metric

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetMaximumIteration ( unsigned int _arg )

virtual

Set/Get maximum iteration limit.

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetMetricWorstPossibleValue ( double _arg )

virtual

void itk::OnePlusOneEvolutionaryOptimizer::SetMinimize ( bool v )

inline

Definition at line 102 of file itkOnePlusOneEvolutionaryOptimizer.h.

void itk::OnePlusOneEvolutionaryOptimizer::SetNormalVariateGenerator ( NormalVariateGeneratorType * generator )

virtual void itk::OnePlusOneEvolutionaryOptimizer::SetShrinkFactor ( double _arg )

virtual

Set/Get the search radius shrink factor.

void itk::OnePlusOneEvolutionaryOptimizer::StartOptimization ( )

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

void itk::OnePlusOneEvolutionaryOptimizer::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 167 of file itkOnePlusOneEvolutionaryOptimizer.h.

Member Data Documentation

bool itk::OnePlusOneEvolutionaryOptimizer::m_CatchGetValueException

private

Definition at line 195 of file itkOnePlusOneEvolutionaryOptimizer.h.

MeasureType itk::OnePlusOneEvolutionaryOptimizer::m_CurrentCost

private

Internal storage for the value type / used as a cache

Definition at line 218 of file itkOnePlusOneEvolutionaryOptimizer.h.

unsigned int itk::OnePlusOneEvolutionaryOptimizer::m_CurrentIteration

private

Current iteration

Definition at line 193 of file itkOnePlusOneEvolutionaryOptimizer.h.

double itk::OnePlusOneEvolutionaryOptimizer::m_Epsilon

private

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

Definition at line 203 of file itkOnePlusOneEvolutionaryOptimizer.h.

double itk::OnePlusOneEvolutionaryOptimizer::m_FrobeniusNorm

private

Cache variable for reporting the Frobenius Norm

Definition at line 231 of file itkOnePlusOneEvolutionaryOptimizer.h.

double itk::OnePlusOneEvolutionaryOptimizer::m_GrowthFactor

private

Search radius growth factor in parameter space.

Definition at line 209 of file itkOnePlusOneEvolutionaryOptimizer.h.

bool itk::OnePlusOneEvolutionaryOptimizer::m_Initialized

private

Flag tells if the optimizer was initialized using Initialize function.

Definition at line 215 of file itkOnePlusOneEvolutionaryOptimizer.h.

double itk::OnePlusOneEvolutionaryOptimizer::m_InitialRadius

private

Initial search radius in parameter space.

Definition at line 206 of file itkOnePlusOneEvolutionaryOptimizer.h.

bool itk::OnePlusOneEvolutionaryOptimizer::m_Maximize

private

Set if the Metric should be maximized: Default = False

Definition at line 199 of file itkOnePlusOneEvolutionaryOptimizer.h.

unsigned int itk::OnePlusOneEvolutionaryOptimizer::m_MaximumIteration

private

Maximum iteration limit.

Definition at line 190 of file itkOnePlusOneEvolutionaryOptimizer.h.

double itk::OnePlusOneEvolutionaryOptimizer::m_MetricWorstPossibleValue

private

Definition at line 196 of file itkOnePlusOneEvolutionaryOptimizer.h.

NormalVariateGeneratorType::Pointer itk::OnePlusOneEvolutionaryOptimizer::m_RandomGenerator

private

Smart pointer to the normal random variate generator.

Definition at line 187 of file itkOnePlusOneEvolutionaryOptimizer.h.

double itk::OnePlusOneEvolutionaryOptimizer::m_ShrinkFactor

private

Search radius shrink factor in parameter space,

Definition at line 212 of file itkOnePlusOneEvolutionaryOptimizer.h.

bool itk::OnePlusOneEvolutionaryOptimizer::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 224 of file itkOnePlusOneEvolutionaryOptimizer.h.

std::ostringstream itk::OnePlusOneEvolutionaryOptimizer::m_StopConditionDescription

private

Stop description

Definition at line 227 of file itkOnePlusOneEvolutionaryOptimizer.h.

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