#include <itkObjectToObjectOptimizerBase.h>

Inheritance diagram for itk::ObjectToObjectOptimizerBase:

Collaboration diagram for itk::ObjectToObjectOptimizerBase:

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. The gradient of each local parameter is divided by the corresponding scale. 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.

SetWeights() allows setting of a per-local-parameter weighting array. If unset, the weights are treated as identity. Weights are multiplied by the gradient at the same time scaling is applied. Weights are different than scales, and may be used, for example, to easily mask out a particular parameter during optimzation to hold it constant. Or they may be used to apply another kind of prior knowledge.

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 67 of file itkObjectToObjectOptimizerBase.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef MetricType::InternalComputationValueType	InternalComputationValueType

typedef MetricType::MeasureType	MeasureType

typedef ObjectToObjectMetricBase	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 Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual const MeasureType &	GetCurrentMetricValue ()

const ParametersType &	GetCurrentPosition ()

virtual const char *	GetNameOfClass () const

virtual const ThreadIdType &	GetNumberOfThreads ()

virtual const ScalesType &	GetScales ()

virtual const bool &	GetScalesAreIdentity ()

const MeasureType &	GetValue ()

virtual const ScalesType &	GetWeights ()

virtual const bool &	GetWeightsAreIdentity ()

virtual void	SetNumberOfThreads (ThreadIdType number)

virtual void	SetScales (ScalesType _arg)

virtual void	SetWeights (ScalesType _arg)

virtual void	StartOptimization (bool doOnlyInitialization=false)


virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()

virtual const MetricType *	GetMetric () 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 ModifiedTimeType	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
virtual void	PrintSelf (std::ostream &os, Indent indent) const


	ObjectToObjectOptimizerBase ()

virtual	~ObjectToObjectOptimizerBase ()

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 ()

Protected Attributes
MeasureType	m_CurrentMetricValue

MetricTypePointer	m_Metric

ThreadIdType	m_NumberOfThreads

ScalesType	m_Scales

bool	m_ScalesAreIdentity

ScalesType	m_Weights

bool	m_WeightsAreIdentity

Private Member Functions
	ObjectToObjectOptimizerBase (const Self &)

void	operator= (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

Member Typedef Documentation

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

Definition at line 74 of file itkObjectToObjectOptimizerBase.h.

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

Internal computation value type

Definition at line 96 of file itkObjectToObjectOptimizerBase.h.

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

Measure type

Definition at line 93 of file itkObjectToObjectOptimizerBase.h.

typedef ObjectToObjectMetricBase itk::ObjectToObjectOptimizerBase::MetricType

Metric function type

Definition at line 86 of file itkObjectToObjectOptimizerBase.h.

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

Definition at line 87 of file itkObjectToObjectOptimizerBase.h.

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

Number of parameters type

Definition at line 90 of file itkObjectToObjectOptimizerBase.h.

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

Parameters type.

Definition at line 83 of file itkObjectToObjectOptimizerBase.h.

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

Definition at line 73 of file itkObjectToObjectOptimizerBase.h.

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

Scale type.

Definition at line 77 of file itkObjectToObjectOptimizerBase.h.

typedef ObjectToObjectOptimizerBase itk::ObjectToObjectOptimizerBase::Self

Standard class typedefs.

Definition at line 71 of file itkObjectToObjectOptimizerBase.h.

typedef Object itk::ObjectToObjectOptimizerBase::Superclass

Definition at line 72 of file itkObjectToObjectOptimizerBase.h.

Constructor & Destructor Documentation

itk::ObjectToObjectOptimizerBase::ObjectToObjectOptimizerBase ( )

protected

Default constructor

virtual itk::ObjectToObjectOptimizerBase::~ObjectToObjectOptimizerBase ( )

protectedvirtual

Default constructor

itk::ObjectToObjectOptimizerBase::ObjectToObjectOptimizerBase ( const Self & )

private

Member Function Documentation

virtual const MeasureType& itk::ObjectToObjectOptimizerBase::GetCurrentMetricValue ( )

virtual

Accessor for metric value. Returns the value stored in m_CurrentMetricValue from the most recent call to evaluate the metric.

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 const MetricType* itk::ObjectToObjectOptimizerBase::GetMetric ( ) const

virtual

Accessors for Metric

virtual MetricType* itk::ObjectToObjectOptimizerBase::GetModifiableMetric ( )

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::GradientDescentOptimizerv4, itk::QuasiNewtonOptimizerv4, itk::GradientDescentLineSearchOptimizerv4, itk::ConjugateGradientLineSearchOptimizerv4, itk::MultiGradientOptimizerv4, itk::MultiStartOptimizerv4, and itk::GradientDescentOptimizerBasev4.

virtual const ThreadIdType& itk::ObjectToObjectOptimizerBase::GetNumberOfThreads ( )

virtual

Get the number of threads set to be used.

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

const MeasureType& itk::ObjectToObjectOptimizerBase::GetValue ( )

Deprecated accessor for currently stored metric value for use by classes that support both v4 and v3 optimizers.

See Also: GetCurrentMetricValue()

virtual const ScalesType& itk::ObjectToObjectOptimizerBase::GetWeights ( )

virtual

Get current parameters weights. This will return an empty array when weights have not been set by user.

virtual const bool& itk::ObjectToObjectOptimizerBase::GetWeightsAreIdentity ( )

virtual

Get whether weights are identity. Cannot be set

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

private

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

protectedvirtual

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::GradientDescentOptimizerv4, itk::QuasiNewtonOptimizerv4, itk::GradientDescentOptimizerBasev4, itk::MultiStartOptimizerv4, itk::MultiGradientOptimizerv4, itk::GradientDescentLineSearchOptimizerv4, and itk::ConjugateGradientLineSearchOptimizerv4.

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. The default is the global default number of threads returned from itkMultiThreader.

virtual void itk::ObjectToObjectOptimizerBase::SetScales ( ScalesType _arg )

virtual

Set current parameters scaling.

virtual void itk::ObjectToObjectOptimizerBase::SetWeights ( ScalesType _arg )

virtual

Set current parameters weights.

virtual void itk::ObjectToObjectOptimizerBase::StartOptimization ( bool doOnlyInitialization = false )

virtual

Run the optimization.

Parameters

doOnlyInitialization This is false by default. It should only be set to true for special cases when the class should be initialized to perform optimization, but no optimization should be run. For example, itkMultiGradientOptimizerv4 needs to do this.

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

Reimplemented in itk::GradientDescentOptimizerv4, itk::MultiStartOptimizerv4, itk::MultiGradientOptimizerv4, itk::QuasiNewtonOptimizerv4, and itk::ConjugateGradientLineSearchOptimizerv4.

Member Data Documentation

MeasureType itk::ObjectToObjectOptimizerBase::m_CurrentMetricValue

protected

Metric measure value at a given iteration, as most recently evaluated.

Definition at line 167 of file itkObjectToObjectOptimizerBase.h.

MetricTypePointer itk::ObjectToObjectOptimizerBase::m_Metric

protected

Definition at line 163 of file itkObjectToObjectOptimizerBase.h.

ThreadIdType itk::ObjectToObjectOptimizerBase::m_NumberOfThreads

protected

Definition at line 164 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 171 of file itkObjectToObjectOptimizerBase.h.

bool itk::ObjectToObjectOptimizerBase::m_ScalesAreIdentity

protected

Flag to avoid unnecessary arithmetic when scales are identity.

Definition at line 180 of file itkObjectToObjectOptimizerBase.h.

ScalesType itk::ObjectToObjectOptimizerBase::m_Weights

protected

Parameter weights. These are applied to local parameters, at the same time as scales. See main documentation. If not set by user, the array remains empty and treated as identity to simplify the reuse of an optimizer with transforms with different numbers of parameters.

Definition at line 177 of file itkObjectToObjectOptimizerBase.h.

bool itk::ObjectToObjectOptimizerBase::m_WeightsAreIdentity

protected

Flag to avoid unnecessary arithmetic when weights are identity.

Definition at line 183 of file itkObjectToObjectOptimizerBase.h.

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