ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::ObjectToObjectOptimizerBase Class Reference

#include <itkObjectToObjectOptimizerBase.h>

+ Inheritance diagram for itk::ObjectToObjectOptimizerBase:
+ Collaboration diagram for itk::ObjectToObjectOptimizerBase:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
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< SelfPointer
typedef OptimizerParameters
< double > 
ScalesType
typedef ObjectToObjectOptimizerBase Self
typedef Object Superclass

Public Member Functions

const ParametersTypeGetCurrentPosition ()
virtual const char * GetNameOfClass () const
virtual const ThreadIdTypeGetNumberOfThreads ()
virtual const ScalesTypeGetScales ()
virtual const bool & GetScalesAreIdentity ()
virtual const MeasureTypeGetValue ()
virtual void SetNumberOfThreads (ThreadIdType number)
virtual void SetScales (ScalesType _arg)
virtual void StartOptimization ()
virtual MetricTypeGetMetric ()
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

Number of parameters type

Definition at line 82 of file itkObjectToObjectOptimizerBase.h.

Parameters type.

Reimplemented in itk::MultiGradientOptimizerv4, and itk::MultiStartOptimizerv4.

Definition at line 75 of file itkObjectToObjectOptimizerBase.h.

Scale type.

Definition at line 69 of file itkObjectToObjectOptimizerBase.h.


Constructor & Destructor Documentation

Default constructor

Default constructor


Member Function Documentation

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.

Accessors for Metric

virtual const char* itk::ObjectToObjectOptimizerBase::GetNameOfClass ( ) const [virtual]

Get the number of threads set to be used.

Get current parameters scaling.

virtual const bool& itk::ObjectToObjectOptimizerBase::GetScalesAreIdentity ( ) [virtual]

Get whether scales are identity. Cannot be set

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

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

virtual void itk::ObjectToObjectOptimizerBase::SetMetric ( MetricType _arg) [virtual]

Accessors for Metric

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.

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


Member Data Documentation

Definition at line 133 of file itkObjectToObjectOptimizerBase.h.

Definition at line 134 of file itkObjectToObjectOptimizerBase.h.

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

Definition at line 141 of file itkObjectToObjectOptimizerBase.h.

Flag to avoid unnecessary arithmetic when scales are identity.

Definition at line 145 of file itkObjectToObjectOptimizerBase.h.

Metric measure value at a given iteration

Definition at line 137 of file itkObjectToObjectOptimizerBase.h.


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