itk::OptimizerParameterScalesEstimator Class Reference

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

#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 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
Protected Member Functions
	OptimizerParameterScalesEstimator ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~OptimizerParameterScalesEstimator ()
Private Member Functions
void	operator= (const Self &)
	OptimizerParameterScalesEstimator (const Self &)

---

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::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShift< 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 >, and itk::RegistrationParameterScalesFromShift< TMetric >.

Definition at line 57 of file itkOptimizerParameterScalesEstimator.h.

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

Type of paramters of the optimizer

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShift< 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::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShift< 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 >, and itk::RegistrationParameterScalesFromShift< 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::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShift< TMetric >.

Definition at line 42 of file itkOptimizerParameterScalesEstimator.h.

typedef Object itk::OptimizerParameterScalesEstimator::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShift< TMetric >.

Definition at line 43 of file itkOptimizerParameterScalesEstimator.h.

---

Constructor & Destructor Documentation

itk::OptimizerParameterScalesEstimator::OptimizerParameterScalesEstimator

(

)

[inline, protected]

Definition at line 73 of file itkOptimizerParameterScalesEstimator.h.

itk::OptimizerParameterScalesEstimator::~OptimizerParameterScalesEstimator

(

)

[inline, protected]

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::RegistrationParameterScalesFromShift< 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::RegistrationParameterScalesFromShift< 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::RegistrationParameterScalesFromShift< 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 >, and itk::RegistrationParameterScalesFromShift< 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 >, and itk::RegistrationParameterScalesFromShift< TMetric >.

void itk::OptimizerParameterScalesEstimator::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [inline, protected, virtual]

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 >, and itk::RegistrationParameterScalesFromShift< TMetric >.

Definition at line 76 of file itkOptimizerParameterScalesEstimator.h.

---

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

• itkOptimizerParameterScalesEstimator.h