itk::ObjectToObjectOptimizerBase Class Reference

Abstract base for object-to-object optimizers. More...

#include <itkObjectToObjectOptimizerBase.h>

Inheritance diagram for itk::ObjectToObjectOptimizerBase:

Collaboration diagram for itk::ObjectToObjectOptimizerBase:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef MetricType::InternalComputationValueType	InternalComputationValueType
typedef MetricType::MeasureType	MeasureType
typedef ObjectToObjectMetric	MetricType
typedef MetricType::Pointer	MetricTypePointer
typedef MetricType::NumberOfParametersType	NumberOfParametersType
typedef OptimizerParameters < double >	ParametersType
typedef SmartPointer< Self >	Pointer
typedef OptimizerParameters < double >	ScalesType
typedef ObjectToObjectOptimizerBase	Self
typedef Object	Superclass
Public Member Functions
const ParametersType &	GetCurrentPosition ()
virtual const char *	GetNameOfClass () const
virtual const ScalesType &	GetScales ()
virtual const bool &	GetScalesAreIdentity ()
virtual const MeasureType &	GetValue ()
virtual void	SetNumberOfThreads (ThreadIdType number)
virtual void	SetScales (ScalesType _arg)
virtual void	StartOptimization ()
virtual MetricType *	GetMetric ()
virtual void	SetMetric (MetricType *_arg)
Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	ObjectToObjectOptimizerBase ()
virtual	~ObjectToObjectOptimizerBase ()
Protected Attributes
MetricTypePointer	m_Metric
ThreadIdType	m_NumberOfThreads
ScalesType	m_Scales
bool	m_ScalesAreIdentity
MeasureType	m_Value
Private Member Functions
	ObjectToObjectOptimizerBase (const Self &)
void	operator= (const Self &)

---

Detailed Description

Abstract base for object-to-object optimizers.

The goal of this optimizer hierarchy is to work with metrics of any type, i.e. working with any kind of object, such as image or point-set.

Transform parameters are not manipulated directly. Instead, the optimizer retrieves the metric derivative from the metric, modifies the derivative as required, then passes it back to the metric as an update. The metric then processes it as appropriate, typically by passing it to its transform that is being optimized.

SetScales allows setting of a per-local-parameter scaling array. If unset, the m_Scales array will be initialized to all 1's. Note that when used with transforms with local support, these scales correspond to each _local_ parameter, and not to each parameter. For example, in a DisplacementFieldTransform of dimensionality N, the Scales is size N, with each element corresponding to a dimension within the transform's displacement field, and is applied to each vector in the displacement field.

Threading of some optimizer operations may be handled within derived classes, for example in GradientDescentOptimizer.

Note:

Derived classes must override StartOptimization, and then call this base class version to perform common initializations.

Definition at line 59 of file itkObjectToObjectOptimizerBase.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object.

Reimplemented in itk::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

Definition at line 66 of file itkObjectToObjectOptimizerBase.h.

typedef MetricType::InternalComputationValueType itk::ObjectToObjectOptimizerBase::InternalComputationValueType

Internal computation value type

Reimplemented in itk::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

Definition at line 89 of file itkObjectToObjectOptimizerBase.h.

typedef MetricType::MeasureType itk::ObjectToObjectOptimizerBase::MeasureType

Measure type

Reimplemented in itk::GradientDescentOptimizerBasev4, and itk::GradientDescentOptimizerv4.

Definition at line 85 of file itkObjectToObjectOptimizerBase.h.

typedef ObjectToObjectMetric itk::ObjectToObjectOptimizerBase::MetricType

Metric function type

Reimplemented in itk::GradientDescentOptimizerBasev4.

Definition at line 78 of file itkObjectToObjectOptimizerBase.h.

typedef MetricType::Pointer itk::ObjectToObjectOptimizerBase::MetricTypePointer

Reimplemented in itk::GradientDescentOptimizerBasev4.

Definition at line 79 of file itkObjectToObjectOptimizerBase.h.

typedef MetricType::NumberOfParametersType itk::ObjectToObjectOptimizerBase::NumberOfParametersType

Number of parameters type

Definition at line 82 of file itkObjectToObjectOptimizerBase.h.

typedef OptimizerParameters< double > itk::ObjectToObjectOptimizerBase::ParametersType

Parameters type.

Definition at line 75 of file itkObjectToObjectOptimizerBase.h.

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

Reimplemented from itk::Object.

Reimplemented in itk::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

Definition at line 65 of file itkObjectToObjectOptimizerBase.h.

typedef OptimizerParameters< double > itk::ObjectToObjectOptimizerBase::ScalesType

Scale type.

Definition at line 69 of file itkObjectToObjectOptimizerBase.h.

typedef ObjectToObjectOptimizerBase itk::ObjectToObjectOptimizerBase::Self

Standard class typedefs.

Reimplemented from itk::Object.

Reimplemented in itk::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

Definition at line 63 of file itkObjectToObjectOptimizerBase.h.

typedef Object itk::ObjectToObjectOptimizerBase::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

Definition at line 64 of file itkObjectToObjectOptimizerBase.h.

---

Constructor & Destructor Documentation

itk::ObjectToObjectOptimizerBase::ObjectToObjectOptimizerBase

(

)

[protected]

Default constructor

virtual itk::ObjectToObjectOptimizerBase::~ObjectToObjectOptimizerBase

(

)

[protected, virtual]

Default constructor

itk::ObjectToObjectOptimizerBase::ObjectToObjectOptimizerBase

(

const Self &

)

[private]

---

Member Function Documentation

const ParametersType& itk::ObjectToObjectOptimizerBase::GetCurrentPosition

(

)

Get a reference to the current position of the optimization. This returns the parameters from the assigned metric, since the optimizer itself does not store a position.

virtual MetricType* itk::ObjectToObjectOptimizerBase::GetMetric

(

)

[virtual]

Accessors for Metric

virtual const char* itk::ObjectToObjectOptimizerBase::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

virtual const ScalesType& itk::ObjectToObjectOptimizerBase::GetScales

(

)

[virtual]

Get current parameters scaling.

virtual const bool& itk::ObjectToObjectOptimizerBase::GetScalesAreIdentity

(

)

[virtual]

Get whether scales are identity. Cannot be set

virtual const MeasureType& itk::ObjectToObjectOptimizerBase::GetValue

(

)

[virtual]

Accessor for metric value

void itk::ObjectToObjectOptimizerBase::operator=

(

const Self &

)

[private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

Reimplemented in itk::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

virtual void itk::ObjectToObjectOptimizerBase::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [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::GradientDescentOptimizerBasev4, itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

virtual void itk::ObjectToObjectOptimizerBase::SetMetric

(

MetricType *

_arg

)

[virtual]

Accessors for Metric

virtual void itk::ObjectToObjectOptimizerBase::SetNumberOfThreads

(

ThreadIdType

number

)

[virtual]

Set the number of threads to use when threading.

virtual void itk::ObjectToObjectOptimizerBase::SetScales

(

ScalesType

_arg

)

[virtual]

Set current parameters scaling.

virtual void itk::ObjectToObjectOptimizerBase::StartOptimization

(

)

[virtual]

Run the optimization.

Note:

Derived classes must override and call this superclass method, then perform any additional initialization before performing optimization.

Reimplemented in itk::GradientDescentOptimizerv4, and itk::QuasiNewtonOptimizerv4.

---

Member Data Documentation

MetricTypePointer itk::ObjectToObjectOptimizerBase::m_Metric [protected]

Definition at line 128 of file itkObjectToObjectOptimizerBase.h.

ThreadIdType itk::ObjectToObjectOptimizerBase::m_NumberOfThreads [protected]

Definition at line 129 of file itkObjectToObjectOptimizerBase.h.

ScalesType itk::ObjectToObjectOptimizerBase::m_Scales [protected]

Scales. Size is expected to be == metric->GetNumberOfLocalParameters(). See the main documentation for more details.

Definition at line 136 of file itkObjectToObjectOptimizerBase.h.

bool itk::ObjectToObjectOptimizerBase::m_ScalesAreIdentity [protected]

Flag to avoid unnecessary arithmetic when scales are identity.

Definition at line 140 of file itkObjectToObjectOptimizerBase.h.

MeasureType itk::ObjectToObjectOptimizerBase::m_Value [protected]

Metric measure value at a given iteration

Definition at line 132 of file itkObjectToObjectOptimizerBase.h.

---

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

• itkObjectToObjectOptimizerBase.h