itk::OptimizerParameterScalesEstimator Class Reference

#include <itkOptimizerParameterScalesEstimator.h>

Inheritance diagram for itk::OptimizerParameterScalesEstimator:

Collaboration diagram for itk::OptimizerParameterScalesEstimator:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef double	FloatType
typedef ObjectToObjectOptimizerBase::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef ObjectToObjectOptimizerBase::ScalesType	ScalesType
typedef OptimizerParameterScalesEstimator	Self
typedef Object	Superclass
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
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)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

---

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.

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::OptimizerParameterScalesEstimator::ConstPointer

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 45 of file itkOptimizerParameterScalesEstimator.h.

typedef double itk::OptimizerParameterScalesEstimator::FloatType

Type of float

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 57 of file itkOptimizerParameterScalesEstimator.h.

typedef ObjectToObjectOptimizerBase::ParametersType itk::OptimizerParameterScalesEstimator::ParametersType

Type of parameters of the optimizer

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 54 of file itkOptimizerParameterScalesEstimator.h.

typedef SmartPointer<Self> itk::OptimizerParameterScalesEstimator::Pointer

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 44 of file itkOptimizerParameterScalesEstimator.h.

typedef ObjectToObjectOptimizerBase::ScalesType itk::OptimizerParameterScalesEstimator::ScalesType

Type of scales

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 48 of file itkOptimizerParameterScalesEstimator.h.

typedef OptimizerParameterScalesEstimator itk::OptimizerParameterScalesEstimator::Self

Standard class typedefs.

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 42 of file itkOptimizerParameterScalesEstimator.h.

typedef Object itk::OptimizerParameterScalesEstimator::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 43 of file itkOptimizerParameterScalesEstimator.h.

---

Constructor & Destructor Documentation

itk::OptimizerParameterScalesEstimator::OptimizerParameterScalesEstimator ( )

inlineprotected

Definition at line 73 of file itkOptimizerParameterScalesEstimator.h.

itk::OptimizerParameterScalesEstimator::~OptimizerParameterScalesEstimator ( )

inlineprotected

Definition at line 74 of file itkOptimizerParameterScalesEstimator.h.

itk::OptimizerParameterScalesEstimator::OptimizerParameterScalesEstimator ( const Self &  )

private

---

Member Function Documentation

virtual void itk::OptimizerParameterScalesEstimator::EstimateLocalStepScales ( const ParametersType &  step, ScalesType &  localStepScales  )

pure virtual

Estimate the scales of local steps.

Implemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.

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

Estimate parameter scales.

Implemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.

virtual FloatType itk::OptimizerParameterScalesEstimator::EstimateStepScale ( const ParametersType &  step )

pure virtual

Estimate the scale of a step.

Implemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

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

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

void itk::OptimizerParameterScalesEstimator::PrintSelf ( std::ostream &  os, Indent  indent  ) const

inlineprotectedvirtual

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

Definition at line 76 of file itkOptimizerParameterScalesEstimator.h.

---

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

• itkOptimizerParameterScalesEstimator.h