itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > Class Template Reference

#include <itkObjectToObjectOptimizerBase.h>

Inheritance diagram for itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >:

Collaboration diagram for itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >:

Detailed Description

template<typename TInternalComputationValueType = double>
class itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >

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.

The user can scale each component of the gradient (derivative) at each iteration in one of two ways:

1) manually, by setting a scaling vector using method SetScales(). 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.

or,

2) automatically, by assigning a ScalesEstimator using SetScalesEstimator(). When ScalesEstimator is assigned, the optimizer is enabled by default to estimate scales, and can be changed via SetDoEstimateScales(). The scales are estimated and assigned once, during the call to StartOptimization(). This option will override any manually-assigned scales.

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef MetricType::DerivativeType	DerivativeType
typedef MetricType::MeasureType	MeasureType
typedef ObjectToObjectMetricBaseTemplate < TInternalComputationValueType >	MetricType
typedef MetricType::Pointer	MetricTypePointer
typedef MetricType::NumberOfParametersType	NumberOfParametersType
typedef OptimizerParameters < TInternalComputationValueType >	ParametersType
typedef SmartPointer< Self >	Pointer
typedef OptimizerParameterScalesEstimatorTemplate < TInternalComputationValueType >	ScalesEstimatorType
typedef OptimizerParameters < TInternalComputationValueType >	ScalesType
typedef ObjectToObjectOptimizerBaseTemplate	Self
typedef std::ostringstream	StopConditionDescriptionType
typedef std::string	StopConditionReturnStringType
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 SizeValueType	GetCurrentIteration () const
virtual const MeasureType &	GetCurrentMetricValue () const
virtual const ParametersType &	GetCurrentPosition () const
virtual const char *	GetNameOfClass () const
virtual SizeValueType	GetNumberOfIterations () const
virtual const ThreadIdType &	GetNumberOfThreads () const
virtual const ScalesType &	GetScales () const
virtual const bool &	GetScalesAreIdentity () const
bool	GetScalesInitialized () const
virtual const StopConditionReturnStringType	GetStopConditionDescription () const =0
virtual const MeasureType &	GetValue () const
virtual const ScalesType &	GetWeights () const
virtual const bool &	GetWeightsAreIdentity () const
virtual void	SetNumberOfIterations (SizeValueType _arg)
virtual void	SetNumberOfThreads (ThreadIdType number)
virtual void	SetScalesEstimator (ScalesEstimatorType *_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
virtual void	SetScales (const ScalesType &scales)
virtual void	SetDoEstimateScales (bool _arg)
virtual const bool &	GetDoEstimateScales () const
virtual void	DoEstimateScalesOn ()
virtual void	DoEstimateScalesOff ()
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 override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () 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 override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () 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 override
	ObjectToObjectOptimizerBaseTemplate ()
virtual	~ObjectToObjectOptimizerBaseTemplate () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object () override
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
SizeValueType	m_CurrentIteration
MeasureType	m_CurrentMetricValue
bool	m_DoEstimateScales
MetricTypePointer	m_Metric
SizeValueType	m_NumberOfIterations
ThreadIdType	m_NumberOfThreads
ScalesType	m_Scales
bool	m_ScalesAreIdentity
ScalesEstimatorType::Pointer	m_ScalesEstimator
ScalesType	m_Weights
bool	m_WeightsAreIdentity
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

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 ()
static Pointer	New ()

Member Typedef Documentation

template<typename TInternalComputationValueType = double>

typedef SmartPointer< const Self > itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ConstPointer

Definition at line 89 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef MetricType::DerivativeType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::DerivativeType

Derivative type

Definition at line 106 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef MetricType::MeasureType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::MeasureType

Measure type

Definition at line 112 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef ObjectToObjectMetricBaseTemplate< TInternalComputationValueType > itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::MetricType

Metric function type

Definition at line 102 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef MetricType::Pointer itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::MetricTypePointer

Definition at line 103 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef MetricType::NumberOfParametersType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::NumberOfParametersType

Number of parameters type

Definition at line 109 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef OptimizerParameters< TInternalComputationValueType > itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ParametersType

Parameters type.

Definition at line 99 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef SmartPointer< Self > itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::Pointer

Definition at line 88 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef OptimizerParameterScalesEstimatorTemplate<TInternalComputationValueType> itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ScalesEstimatorType

Definition at line 96 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef OptimizerParameters< TInternalComputationValueType > itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ScalesType

Scale type.

Definition at line 92 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef ObjectToObjectOptimizerBaseTemplate itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::Self

Standard class typedefs.

Definition at line 86 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef std::ostringstream itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::StopConditionDescriptionType

Stop condition internal string type

Definition at line 118 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef std::string itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::StopConditionReturnStringType

Stop condition return string type

Definition at line 115 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

typedef Object itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::Superclass

Definition at line 87 of file itkObjectToObjectOptimizerBase.h.

Constructor & Destructor Documentation

template<typename TInternalComputationValueType = double>

itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ObjectToObjectOptimizerBaseTemplate ( )

protected

Default constructor

template<typename TInternalComputationValueType = double>

virtual itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::~ObjectToObjectOptimizerBaseTemplate ( )

overrideprotectedvirtual

Default constructor

Member Function Documentation

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::DoEstimateScalesOff ( )

virtual

Option to use ScalesEstimator for scales estimation. The estimation is performed once at begin of optimization, and overrides any scales set using SetScales(). Default is true.

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::DoEstimateScalesOn ( )

virtual

Option to use ScalesEstimator for scales estimation. The estimation is performed once at begin of optimization, and overrides any scales set using SetScales(). Default is true.

template<typename TInternalComputationValueType = double>

virtual SizeValueType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetCurrentIteration ( ) const

virtual

Return current number of iterations.

Reimplemented in itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType = double>

virtual const MeasureType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetCurrentMetricValue ( ) const

virtual

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

template<typename TInternalComputationValueType = double>

virtual const ParametersType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetCurrentPosition ( ) const

virtual

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.

template<typename TInternalComputationValueType = double>

virtual const bool& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetDoEstimateScales ( ) const

virtual

Option to use ScalesEstimator for scales estimation. The estimation is performed once at begin of optimization, and overrides any scales set using SetScales(). Default is true.

template<typename TInternalComputationValueType = double>

virtual const MetricType* itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetMetric ( ) const

virtual

Accessors for Metric

template<typename TInternalComputationValueType = double>

virtual MetricType* itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetModifiableMetric ( )

virtual

Accessors for Metric

template<typename TInternalComputationValueType = double>

virtual const char* itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::LBFGS2Optimizerv4, itk::LBFGSOptimizerv4, itk::ExhaustiveOptimizerv4< TInternalComputationValueType >, itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >, itk::LBFGSOptimizerBasev4< vnl_lbfgs >, itk::LBFGSOptimizerBasev4< vnl_lbfgsb >, itk::LBFGSBOptimizerv4, itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >, itk::AmoebaOptimizerv4, itk::PowellOptimizerv4< TInternalComputationValueType >, itk::QuasiNewtonOptimizerv4Template< TInternalComputationValueType >, itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >, itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >, itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >, itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >, itk::MultiStartOptimizerv4Template< TInternalComputationValueType >, itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >, and itk::SingleValuedNonLinearVnlOptimizerv4.

template<typename TInternalComputationValueType = double>

virtual SizeValueType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetNumberOfIterations ( ) const

virtual

Get the number of iterations.

Reimplemented in itk::LBFGS2Optimizerv4, and itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType = double>

virtual const ThreadIdType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetNumberOfThreads ( ) const

virtual

Get the number of threads set to be used.

template<typename TInternalComputationValueType = double>

virtual const ScalesType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetScales ( ) const

virtual

Get current parameters scaling.

template<typename TInternalComputationValueType = double>

virtual const bool& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetScalesAreIdentity ( ) const

virtual

Get whether scales are identity. Cannot be set

template<typename TInternalComputationValueType = double>

bool itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetScalesInitialized

(

)

const

Get whether the scales have been set. Returns true if m_Scales.Size() > 0

template<typename TInternalComputationValueType = double>

virtual const StopConditionReturnStringType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetStopConditionDescription ( ) const

pure virtual

Stop condition return string type

Implemented in itk::LBFGS2Optimizerv4, itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >, itk::AmoebaOptimizerv4, itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >, itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >, itk::LBFGSOptimizerBasev4< vnl_lbfgs >, itk::LBFGSOptimizerBasev4< vnl_lbfgsb >, itk::PowellOptimizerv4< TInternalComputationValueType >, itk::ExhaustiveOptimizerv4< TInternalComputationValueType >, itk::MultiStartOptimizerv4Template< TInternalComputationValueType >, itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >, and itk::SingleValuedNonLinearVnlOptimizerv4.

template<typename TInternalComputationValueType = double>

virtual const MeasureType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetValue ( ) const

virtual

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

See Also

GetCurrentMetricValue()

Reimplemented in itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >, and itk::PowellOptimizerv4< TInternalComputationValueType >.

template<typename TInternalComputationValueType = double>

virtual const ScalesType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetWeights ( ) const

virtual

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

template<typename TInternalComputationValueType = double>

virtual const bool& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetWeightsAreIdentity ( ) const

virtual

Get whether weights are identity. Cannot be set

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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::LBFGS2Optimizerv4, itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >, itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, itk::QuasiNewtonOptimizerv4Template< TInternalComputationValueType >, itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >, itk::LBFGSBOptimizerv4, itk::AmoebaOptimizerv4, itk::ExhaustiveOptimizerv4< TInternalComputationValueType >, itk::MultiStartOptimizerv4Template< TInternalComputationValueType >, itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >, itk::PowellOptimizerv4< TInternalComputationValueType >, itk::LBFGSOptimizerBasev4< vnl_lbfgs >, itk::LBFGSOptimizerBasev4< vnl_lbfgsb >, itk::LBFGSOptimizerv4, itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >, itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >, itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >, itk::SingleValuedNonLinearVnlOptimizerv4, and itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetDoEstimateScales ( bool  _arg )

virtual

Option to use ScalesEstimator for scales estimation. The estimation is performed once at begin of optimization, and overrides any scales set using SetScales(). Default is true.

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetMetric ( MetricType *  _arg )

virtual

Accessors for Metric

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetNumberOfIterations ( SizeValueType  _arg )

virtual

Set the number of iterations.

Reimplemented in itk::LBFGS2Optimizerv4, and itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::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.

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetScales ( const ScalesType &  scales )

inlinevirtual

Set current parameters scaling.

Definition at line 139 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetScalesEstimator ( ScalesEstimatorType *  _arg )

virtual

Set the scales estimator.

A ScalesEstimator is required for the scales estimation options to work. See the main documentation. Derived classes may also provide learning-rate estimation, in which case a scales estimator is also required.

See Also

SetDoEstimateScales()

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetWeights ( ScalesType  _arg )

virtual

Set current parameters weights.

template<typename TInternalComputationValueType = double>

virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::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::GradientDescentOptimizerv4Template< TInternalComputationValueType >, itk::LBFGS2Optimizerv4, itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >, itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >, itk::PowellOptimizerv4< TInternalComputationValueType >, itk::LBFGSBOptimizerv4, itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >, itk::ExhaustiveOptimizerv4< TInternalComputationValueType >, itk::LBFGSOptimizerv4, itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >, itk::MultiStartOptimizerv4Template< TInternalComputationValueType >, itk::LBFGSOptimizerBasev4< vnl_lbfgs >, itk::LBFGSOptimizerBasev4< vnl_lbfgsb >, itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >, itk::QuasiNewtonOptimizerv4Template< TInternalComputationValueType >, itk::AmoebaOptimizerv4, itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >, and itk::SingleValuedNonLinearVnlOptimizerv4.

Member Data Documentation

template<typename TInternalComputationValueType = double>

SizeValueType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_CurrentIteration

protected

Definition at line 229 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

MeasureType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_CurrentMetricValue

protected

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

Definition at line 233 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

bool itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_DoEstimateScales

protected

Flag to control use of the ScalesEstimator (if set) for automatic scale estimation during StartOptimization()

Definition at line 257 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

MetricTypePointer itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_Metric

protected

Definition at line 227 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

SizeValueType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_NumberOfIterations

protected

Definition at line 230 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

ThreadIdType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_NumberOfThreads

protected

Definition at line 228 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

ScalesType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_Scales

protected

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

Definition at line 237 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

bool itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_ScalesAreIdentity

protected

Flag to avoid unnecessary arithmetic when scales are identity.

Definition at line 246 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

ScalesEstimatorType::Pointer itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_ScalesEstimator

protected

Scales estimator. Optionally provided by user.

Definition at line 249 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

ScalesType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::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 243 of file itkObjectToObjectOptimizerBase.h.

template<typename TInternalComputationValueType = double>

bool itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_WeightsAreIdentity

protected

Flag to avoid unnecessary arithmetic when weights are identity.

Definition at line 252 of file itkObjectToObjectOptimizerBase.h.

---

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

• itkObjectToObjectOptimizerBase.h