ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::OptimizerParameterScalesEstimator Class Referenceabstract

#include <itkOptimizerParameterScalesEstimator.h>

+ Inheritance diagram for itk::OptimizerParameterScalesEstimator:
+ Collaboration diagram for itk::OptimizerParameterScalesEstimator:

Detailed Description

OptimizerParameterScalesEstimator is the base class offering a empty method of estimating the parameter scales for optimizers.

Its subclass RegistrationParameterScalesEstimator estimates scales for registration optimizers.

Definition at line 38 of file itkOptimizerParameterScalesEstimator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef double FloatType
typedef SmartPointer< SelfPointer
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 void EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)=0
virtual FloatType EstimateMaximumStepSize ()=0
virtual void EstimateScales (ScalesType &scales)=0
virtual FloatType EstimateStepScale (const ParametersType &step)=0
virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) 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
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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

Protected Member Functions

 OptimizerParameterScalesEstimator ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~OptimizerParameterScalesEstimator ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- 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 ()

Private Member Functions

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

Additional Inherited Members

- 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)
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock

Member Typedef Documentation

Definition at line 45 of file itkOptimizerParameterScalesEstimator.h.

Type of float

Definition at line 57 of file itkOptimizerParameterScalesEstimator.h.

Type of parameters of the optimizer

Definition at line 54 of file itkOptimizerParameterScalesEstimator.h.

Definition at line 44 of file itkOptimizerParameterScalesEstimator.h.

Type of scales

Definition at line 48 of file itkOptimizerParameterScalesEstimator.h.

Standard class typedefs.

Definition at line 42 of file itkOptimizerParameterScalesEstimator.h.

Definition at line 43 of file itkOptimizerParameterScalesEstimator.h.

Constructor & Destructor Documentation

itk::OptimizerParameterScalesEstimator::OptimizerParameterScalesEstimator ( )

Definition at line 73 of file itkOptimizerParameterScalesEstimator.h.

itk::OptimizerParameterScalesEstimator::~OptimizerParameterScalesEstimator ( )

Definition at line 74 of file itkOptimizerParameterScalesEstimator.h.

itk::OptimizerParameterScalesEstimator::OptimizerParameterScalesEstimator ( const Self )

Member Function Documentation

virtual void itk::OptimizerParameterScalesEstimator::EstimateLocalStepScales ( const ParametersType step,
ScalesType localStepScales 
pure virtual
virtual FloatType itk::OptimizerParameterScalesEstimator::EstimateMaximumStepSize ( )
pure virtual

Estimate the maximum size for steps.

Implemented in itk::RegistrationParameterScalesEstimator< TMetric >.

virtual void itk::OptimizerParameterScalesEstimator::EstimateScales ( ScalesType scales)
pure virtual
virtual FloatType itk::OptimizerParameterScalesEstimator::EstimateStepScale ( const ParametersType step)
pure virtual
virtual const char* itk::OptimizerParameterScalesEstimator::GetNameOfClass ( ) const
void itk::OptimizerParameterScalesEstimator::operator= ( const Self )
void itk::OptimizerParameterScalesEstimator::PrintSelf ( std::ostream &  os,
Indent  indent 
) const

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::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 76 of file itkOptimizerParameterScalesEstimator.h.

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