ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::Optimizer Class Reference

Generic representation for an optimization method. More...

#include <itkOptimizer.h>

Inheritance diagram for itk::Optimizer:
Collaboration diagram for itk::Optimizer:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef OptimizerParameters
< double > 
ParametersType
typedef SmartPointer< SelfPointer
typedef Array< double > ScalesType
typedef Optimizer Self
typedef Object Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const ParametersTypeGetCurrentPosition ()
virtual const ParametersTypeGetInitialPosition ()
virtual const char * GetNameOfClass () const
virtual const ScalesTypeGetScales ()
virtual const std::string GetStopConditionDescription () const
virtual void SetInitialPosition (const ParametersType &param)
void SetScales (const ScalesType &scales)
virtual void StartOptimization ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

Protected Attributes

ParametersType m_CurrentPosition
bool m_ScalesInitialized

Private Member Functions

void operator= (const Self &)
 Optimizer (const Self &)

Private Attributes

ParametersType m_InitialPosition
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 37 of file itkOptimizer.h.


Member Typedef Documentation

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.

Reimplemented in itk::NonLinearOptimizer.

Definition at line 62 of file itkOptimizer.h.


Constructor & Destructor Documentation

itk::Optimizer::Optimizer ( ) [protected]
virtual itk::Optimizer::~Optimizer ( ) [inline, protected, virtual]

Definition at line 87 of file itkOptimizer.h.

itk::Optimizer::Optimizer ( const Self ) [private]

Member Function Documentation

virtual::itk::LightObject::Pointer itk::Optimizer::CreateAnother ( void  ) const [virtual]
virtual const ParametersType& itk::Optimizer::GetCurrentPosition ( ) [virtual]

Get current position of the optimization.

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

Get the position to initialize the optimization.

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

Get current parameters scaling.

virtual const std::string itk::Optimizer::GetStopConditionDescription ( ) const [virtual]
static Pointer itk::Optimizer::New ( ) [static]
void itk::Optimizer::operator= ( const Self ) [private]
void itk::Optimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]
virtual void itk::Optimizer::SetCurrentPosition ( const ParametersType param) [protected, virtual]

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  ) [inline, virtual]

Member Data Documentation

Definition at line 98 of file itkOptimizer.h.

Definition at line 103 of file itkOptimizer.h.

Definition at line 104 of file itkOptimizer.h.

Definition at line 93 of file itkOptimizer.h.


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