itk::Optimizer Class Reference

#include <itkOptimizer.h>

Detailed Description

Generic representation for an optimization method.

This class is a base for a hierarchy of optimizers. It is not intended to be instantiated.

Definition at line 38 of file itkOptimizer.h.

Inheritance diagram for itk::Optimizer:

Collaboration diagram for itk::Optimizer:

Public Types
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 const ParametersType &	GetCurrentPosition () const
virtual const ParametersType &	GetInitialPosition () const
const char *	GetNameOfClass () const override
virtual std::string	GetStopConditionDescription () const
virtual void	SetInitialPosition (const ParametersType &param)
void	SetScales (const ScalesType &scales)
virtual void	StartOptimization ()
virtual const ScalesType &	GetScales () const
virtual const ScalesType &	GetInverseScales () const
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
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
	Optimizer ()
void	PrintSelf (std::ostream &os, Indent indent) const override
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 &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 ()

Protected Attributes
ParametersType	m_CurrentPosition {}
bool	m_ScalesInitialized { false }
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Attributes
ParametersType	m_InitialPosition {}
ScalesType	m_InverseScales {}
ScalesType	m_Scales {}

Member Typedef Documentation

ConstPointer

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

Definition at line 47 of file itkOptimizer.h.

ParametersType

using itk::Optimizer::ParametersType = OptimizerParameters<double>

Parameters type. It defines a position in the optimization search space.

Definition at line 57 of file itkOptimizer.h.

Pointer

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

Definition at line 46 of file itkOptimizer.h.

ScalesType

using itk::Optimizer::ScalesType = Array<double>

Scale type. This array defines scale to be applied to parameters before being evaluated in the cost function. This allows to map to a more convenient space. In particular this is used to normalize parameter spaces in which some parameters have a different dynamic range.

Definition at line 65 of file itkOptimizer.h.

Self

using itk::Optimizer::Self = Optimizer

Standard class type aliases.

Definition at line 44 of file itkOptimizer.h.

Superclass

using itk::Optimizer::Superclass = Object

Definition at line 45 of file itkOptimizer.h.

Constructor & Destructor Documentation

Optimizer()

itk::Optimizer::Optimizer ( )

protected

~Optimizer()

itk::Optimizer::~Optimizer ( )

overrideprotecteddefault

Member Function Documentation

GetCurrentPosition()

virtual const ParametersType& itk::Optimizer::GetCurrentPosition ( ) const

virtual

Get current position of the optimization.

GetInitialPosition()

virtual const ParametersType& itk::Optimizer::GetInitialPosition ( ) const

virtual

Get the position to initialize the optimization.

GetInverseScales()

virtual const ScalesType& itk::Optimizer::GetInverseScales ( ) const

virtual

Get current parameters scaling.

GetNameOfClass()

const char* itk::Optimizer::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Reimplemented in itk::SPSAOptimizer, itk::PowellOptimizer, itk::ParticleSwarmOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::ParticleSwarmOptimizerBase, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::SingleValuedNonLinearOptimizer, and itk::RegularStepGradientDescentOptimizer.

GetScales()

virtual const ScalesType& itk::Optimizer::GetScales ( ) const

virtual

Get current parameters scaling.

GetStopConditionDescription()

virtual std::string itk::Optimizer::GetStopConditionDescription ( ) const

virtual

Get the reason for termination

Reimplemented in itk::SPSAOptimizer, itk::ParticleSwarmOptimizerBase, itk::LBFGSBOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::LBFGSOptimizer, itk::GradientDescentOptimizer, itk::AmoebaOptimizer, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::ExhaustiveOptimizer, itk::CumulativeGaussianOptimizer, and itk::LevenbergMarquardtOptimizer.

New()

static Pointer itk::Optimizer::New ( )

static

Method for creation through the object factory.

PrintSelf()

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

Reimplemented in itk::SPSAOptimizer, itk::ParticleSwarmOptimizerBase, itk::PowellOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::ParticleSwarmOptimizer, and itk::SingleValuedNonLinearOptimizer.

SetCurrentPosition()

virtual void itk::Optimizer::SetCurrentPosition ( const ParametersType &  param )

protectedvirtual

Set the current position.

SetInitialPosition()

virtual void itk::Optimizer::SetInitialPosition ( const ParametersType &  param )

virtual

Set the position to initialize the optimization.

SetScales()

void itk::Optimizer::SetScales

(

const ScalesType &

scales

)

Set current parameters scaling.

StartOptimization()

virtual void itk::Optimizer::StartOptimization ( )

inlinevirtual

Start optimization.

Reimplemented in itk::OnePlusOneEvolutionaryOptimizer, itk::PowellOptimizer, itk::GradientDescentOptimizer, itk::ParticleSwarmOptimizerBase, itk::LBFGSOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::ExhaustiveOptimizer, itk::LBFGSBOptimizer, itk::FRPROptimizer, itk::SPSAOptimizer, itk::AmoebaOptimizer, itk::CumulativeGaussianOptimizer, itk::LevenbergMarquardtOptimizer, and itk::ConjugateGradientOptimizer.

Definition at line 88 of file itkOptimizer.h.

Member Data Documentation

m_CurrentPosition

ParametersType itk::Optimizer::m_CurrentPosition {}

protected

Definition at line 110 of file itkOptimizer.h.

m_InitialPosition

ParametersType itk::Optimizer::m_InitialPosition {}

private

Definition at line 113 of file itkOptimizer.h.

m_InverseScales

ScalesType itk::Optimizer::m_InverseScales {}

private

Definition at line 115 of file itkOptimizer.h.

m_Scales

ScalesType itk::Optimizer::m_Scales {}

private

Definition at line 114 of file itkOptimizer.h.

m_ScalesInitialized

bool itk::Optimizer::m_ScalesInitialized { false }

protected

Definition at line 105 of file itkOptimizer.h.

---

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

• itkOptimizer.h