ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
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

typedef SmartPointer< const SelfConstPointer
typedef OptimizerParameters
< double > 
typedef SmartPointer< SelfPointer
typedef Array< double > ScalesType
typedef Optimizer Self
typedef Object Superclass
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Object Self
typedef LightObject Superclass
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef LightObject Self

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
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
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
virtual void Register () const override
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int) override
virtual void UnRegister () const noexceptoverride
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 ()
virtual void PrintSelf (std::ostream &os, Indent indent) const override
virtual void SetCurrentPosition (const ParametersType &param)
virtual ~Optimizer () override
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~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
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount

Private Attributes

ParametersType m_InitialPosition
ScalesType m_InverseScales
ScalesType m_Scales

Member Typedef Documentation

Definition at line 45 of file itkOptimizer.h.

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

Definition at line 51 of file itkOptimizer.h.

Definition at line 44 of file itkOptimizer.h.

typedef Array< double > itk::Optimizer::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 63 of file itkOptimizer.h.

Standard class typedefs.

Definition at line 42 of file itkOptimizer.h.

Definition at line 43 of file itkOptimizer.h.

Constructor & Destructor Documentation

itk::Optimizer::Optimizer ( )
virtual itk::Optimizer::~Optimizer ( )

Definition at line 90 of file itkOptimizer.h.

Member Function Documentation

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

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

Get current position of the optimization.

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

Get the position to initialize the optimization.

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

Get current parameters scaling.

virtual const char* itk::Optimizer::GetNameOfClass ( ) const
virtual const ScalesType& itk::Optimizer::GetScales ( ) const

Get current parameters scaling.

virtual const std::string itk::Optimizer::GetStopConditionDescription ( ) const
static Pointer itk::Optimizer::New ( )

Method for creation through the object factory.

virtual void itk::Optimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
virtual void itk::Optimizer::SetCurrentPosition ( const ParametersType param)

Set the current position.

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

Set the position to initialize the optimization.

void itk::Optimizer::SetScales ( const ScalesType scales)

Set current parameters scaling.

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

Member Data Documentation

ParametersType itk::Optimizer::m_CurrentPosition

Definition at line 101 of file itkOptimizer.h.

ParametersType itk::Optimizer::m_InitialPosition

Definition at line 104 of file itkOptimizer.h.

ScalesType itk::Optimizer::m_InverseScales

Definition at line 108 of file itkOptimizer.h.

ScalesType itk::Optimizer::m_Scales

Definition at line 107 of file itkOptimizer.h.

bool itk::Optimizer::m_ScalesInitialized

Definition at line 96 of file itkOptimizer.h.

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