ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members

#include <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 ParametersTypeGetCurrentPosition () const
 
virtual const ParametersTypeGetInitialPosition () 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 ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 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 {}
 

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.

Member Typedef Documentation

◆ ConstPointer

Definition at line 47 of file itkOptimizer.h.

◆ ParametersType

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

Definition at line 57 of file itkOptimizer.h.

◆ Pointer

Definition at line 46 of file itkOptimizer.h.

◆ ScalesType

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

Standard class type aliases.

Definition at line 44 of file itkOptimizer.h.

◆ Superclass

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

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

◆ GetScales()

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

Get current parameters scaling.

◆ GetStopConditionDescription()

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

◆ 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

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: