itk::Optimizer Class Reference

#include <itkOptimizer.h>

Inheritance diagram for itk::Optimizer:

Collaboration diagram for itk::Optimizer:

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.

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 ::itk::LightObject::Pointer	CreateAnother () const
virtual const ParametersType &	GetCurrentPosition () const
virtual const ParametersType &	GetInitialPosition () const
virtual const char *	GetNameOfClass () const
virtual const 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 *)
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::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
	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 &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 ()

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

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

Definition at line 47 of file itkOptimizer.h.

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.

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

Definition at line 46 of file itkOptimizer.h.

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.

using itk::Optimizer::Self = Optimizer

Standard class type aliases.

Definition at line 44 of file itkOptimizer.h.

using itk::Optimizer::Superclass = Object

Definition at line 45 of file itkOptimizer.h.

Constructor & Destructor Documentation

itk::Optimizer::Optimizer ( )

protected

itk::Optimizer::~Optimizer ( )

overrideprotecteddefault

Member Function Documentation

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

Reimplemented in itk::PowellOptimizer, itk::ParticleSwarmOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::VersorRigid3DTransformOptimizer, itk::SPSAOptimizer, itk::IterateNeighborhoodOptimizer, itk::SingleValuedNonLinearOptimizer, itk::RegularStepGradientDescentBaseOptimizer, and itk::RegularStepGradientDescentOptimizer.

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

virtual

Get current position of the optimization.

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

virtual

Get the position to initialize the optimization.

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

virtual

Get current parameters scaling.

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::LBFGSOptimizer, itk::ExhaustiveOptimizer, itk::InitializationBiasedParticleSwarmOptimizer, itk::OnePlusOneEvolutionaryOptimizer, itk::AmoebaOptimizer, itk::LBFGSBOptimizer, itk::PowellOptimizer, itk::ParticleSwarmOptimizer, itk::CumulativeGaussianOptimizer, itk::ParticleSwarmOptimizerBase, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::VersorTransformOptimizer, itk::GradientDescentOptimizer, itk::VersorRigid3DTransformOptimizer, itk::FRPROptimizer, itk::SPSAOptimizer, itk::IterateNeighborhoodOptimizer, itk::MultipleValuedNonLinearOptimizer, itk::SingleValuedNonLinearOptimizer, itk::ConjugateGradientOptimizer, itk::MultipleValuedNonLinearVnlOptimizer, itk::NonLinearOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::RegularStepGradientDescentOptimizer, and itk::LevenbergMarquardtOptimizer.

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

virtual

Get current parameters scaling.

virtual const 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::AmoebaOptimizer, itk::PowellOptimizer, itk::GradientDescentOptimizer, itk::ExhaustiveOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::CumulativeGaussianOptimizer, and itk::LevenbergMarquardtOptimizer.

static Pointer itk::Optimizer::New ( )

static

Method for creation through the object factory.

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::IterateNeighborhoodOptimizer, itk::SingleValuedNonLinearVnlOptimizer, itk::RegularStepGradientDescentBaseOptimizer, itk::ParticleSwarmOptimizer, and itk::SingleValuedNonLinearOptimizer.

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

protectedvirtual

Set the current position.

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

virtual

Set the position to initialize the optimization.

void itk::Optimizer::SetScales

(

const ScalesType &

scales

)

Set current parameters scaling.

virtual void itk::Optimizer::StartOptimization ( void  )

inlinevirtual

Start optimization.

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

Definition at line 85 of file itkOptimizer.h.

Member Data Documentation

ParametersType itk::Optimizer::m_CurrentPosition

protected

Definition at line 103 of file itkOptimizer.h.

ParametersType itk::Optimizer::m_InitialPosition

private

Definition at line 106 of file itkOptimizer.h.

ScalesType itk::Optimizer::m_InverseScales

private

Definition at line 108 of file itkOptimizer.h.

ScalesType itk::Optimizer::m_Scales

private

Definition at line 107 of file itkOptimizer.h.

bool itk::Optimizer::m_ScalesInitialized { false }

protected

Definition at line 98 of file itkOptimizer.h.

---

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

• itkOptimizer.h