ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType > Class Template Referenceabstract
Group Numerics » Module ITKOptimizersv4

#include <itkObjectToObjectOptimizerBase.h>

+ Inheritance diagram for itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >:
+ Collaboration diagram for itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = typename MetricType::DerivativeType
 
using MeasureType = typename MetricType::MeasureType
 
using MetricType = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
 
using MetricTypePointer = typename MetricType::Pointer
 
using NumberOfParametersType = typename MetricType::NumberOfParametersType
 
using ParametersType = OptimizerParameters< TInternalComputationValueType >
 
using Pointer = SmartPointer< Self >
 
using ScalesEstimatorType = OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >
 
using ScalesType = OptimizerParameters< TInternalComputationValueType >
 
using Self = ObjectToObjectOptimizerBaseTemplate
 
using StopConditionDescriptionType = std::ostringstream
 
using StopConditionReturnStringType = std::string
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
MetricTypePointer m_Metric
 
ThreadIdType m_NumberOfWorkUnits
 
SizeValueType m_CurrentIteration
 
SizeValueType m_NumberOfIterations
 
MeasureType m_CurrentMetricValue
 
ScalesType m_Scales
 
ScalesType m_Weights
 
bool m_ScalesAreIdentity
 
ScalesEstimatorType::Pointer m_ScalesEstimator
 
bool m_WeightsAreIdentity
 
bool m_DoEstimateScales
 
virtual void SetMetric (MetricType *_arg)
 
virtual MetricType * GetModifiableMetric ()
 
virtual const MetricType * GetMetric () const
 
virtual const MeasureType & GetCurrentMetricValue () const
 
virtual const MeasureType & GetValue () const
 
virtual void SetScales (const ScalesType &scales)
 
virtual const ScalesType & GetScales () const
 
virtual const bool & GetScalesAreIdentity () const
 
virtual void SetWeights (ScalesType _arg)
 
virtual const ScalesType & GetWeights () const
 
virtual const bool & GetWeightsAreIdentity () const
 
bool GetScalesInitialized () const
 
virtual void SetScalesEstimator (ScalesEstimatorType *_arg)
 
virtual void SetDoEstimateScales (bool _arg)
 
virtual const bool & GetDoEstimateScales () const
 
virtual void DoEstimateScalesOn ()
 
virtual void DoEstimateScalesOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType number)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
virtual SizeValueType GetCurrentIteration () const
 
virtual void SetNumberOfIterations (SizeValueType _arg)
 
virtual SizeValueType GetNumberOfIterations () const
 
virtual const ParametersType & GetCurrentPosition () const
 
virtual void StartOptimization (bool doOnlyInitialization=false)
 
virtual const StopConditionReturnStringType GetStopConditionDescription () const =0
 
 ObjectToObjectOptimizerBaseTemplate ()
 
 ~ObjectToObjectOptimizerBaseTemplate () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 122 of file itkObjectToObjectOptimizerBase.h.

◆ DerivativeType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::DerivativeType = typename MetricType::DerivativeType

Derivative type

Definition at line 139 of file itkObjectToObjectOptimizerBase.h.

◆ MeasureType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::MeasureType = typename MetricType::MeasureType

Measure type

Definition at line 145 of file itkObjectToObjectOptimizerBase.h.

◆ MetricType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::MetricType = ObjectToObjectMetricBaseTemplate<TInternalComputationValueType>

Metric function type

Definition at line 135 of file itkObjectToObjectOptimizerBase.h.

◆ MetricTypePointer

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::MetricTypePointer = typename MetricType::Pointer

Definition at line 136 of file itkObjectToObjectOptimizerBase.h.

◆ NumberOfParametersType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::NumberOfParametersType = typename MetricType::NumberOfParametersType

Number of parameters type

Definition at line 142 of file itkObjectToObjectOptimizerBase.h.

◆ ParametersType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ParametersType = OptimizerParameters<TInternalComputationValueType>

Parameters type.

Definition at line 132 of file itkObjectToObjectOptimizerBase.h.

◆ Pointer

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 121 of file itkObjectToObjectOptimizerBase.h.

◆ ScalesEstimatorType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ScalesEstimatorType = OptimizerParameterScalesEstimatorTemplate<TInternalComputationValueType>

Definition at line 129 of file itkObjectToObjectOptimizerBase.h.

◆ ScalesType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ScalesType = OptimizerParameters<TInternalComputationValueType>

Scale type.

Definition at line 128 of file itkObjectToObjectOptimizerBase.h.

◆ Self

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::Self = ObjectToObjectOptimizerBaseTemplate

Standard class type aliases.

Definition at line 119 of file itkObjectToObjectOptimizerBase.h.

◆ StopConditionDescriptionType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::StopConditionDescriptionType = std::ostringstream

Stop condition internal string type

Definition at line 151 of file itkObjectToObjectOptimizerBase.h.

◆ StopConditionReturnStringType

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::StopConditionReturnStringType = std::string

Stop condition return string type

Definition at line 148 of file itkObjectToObjectOptimizerBase.h.

◆ Superclass

template<typename TInternalComputationValueType = double>
using itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::Superclass = Object

Definition at line 120 of file itkObjectToObjectOptimizerBase.h.

Constructor & Destructor Documentation

◆ ObjectToObjectOptimizerBaseTemplate()

template<typename TInternalComputationValueType = double>
itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::ObjectToObjectOptimizerBaseTemplate ( )
protected

Default constructor

◆ ~ObjectToObjectOptimizerBaseTemplate()

template<typename TInternalComputationValueType = double>
itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::~ObjectToObjectOptimizerBaseTemplate ( )
overrideprotected

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

Member Function Documentation

◆ DoEstimateScalesOff()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::DoEstimateScalesOff ( )
virtual

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

◆ DoEstimateScalesOn()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::DoEstimateScalesOn ( )
virtual

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

◆ GetCurrentIteration()

template<typename TInternalComputationValueType = double>
virtual SizeValueType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetCurrentIteration ( ) const
virtual

Return current number of iterations.

Reimplemented in itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >.

◆ GetCurrentMetricValue()

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.

◆ GetCurrentPosition()

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.

◆ GetDoEstimateScales()

template<typename TInternalComputationValueType = double>
virtual const bool& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetDoEstimateScales ( ) const
virtual

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

◆ GetMetric()

template<typename TInternalComputationValueType = double>
virtual const MetricType* itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetMetric ( ) const
virtual

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

◆ GetModifiableMetric()

template<typename TInternalComputationValueType = double>
virtual MetricType* itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetModifiableMetric ( )
virtual

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

◆ GetNameOfClass()

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::QuasiNewtonOptimizerv4Template< TInternalComputationValueType >, itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >, itk::PowellOptimizerv4< TInternalComputationValueType >, itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >, itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >, itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >, itk::MultiStartOptimizerv4Template< TInternalComputationValueType >, itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >, and itk::SingleValuedNonLinearVnlOptimizerv4.

◆ GetNumberOfIterations()

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 >.

◆ GetNumberOfWorkUnits()

template<typename TInternalComputationValueType = double>
virtual const ThreadIdType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetNumberOfWorkUnits ( ) const
virtual

Get the number of work units set to be used.

◆ GetScales()

template<typename TInternalComputationValueType = double>
virtual const ScalesType& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetScales ( ) const
virtual

Get current parameters scaling.

◆ GetScalesAreIdentity()

template<typename TInternalComputationValueType = double>
virtual const bool& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetScalesAreIdentity ( ) const
virtual

Get whether scales are identity. Cannot be set

◆ GetScalesInitialized()

template<typename TInternalComputationValueType = double>
bool itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetScalesInitialized ( ) const

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

◆ GetStopConditionDescription()

template<typename TInternalComputationValueType = double>
virtual const StopConditionReturnStringType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetStopConditionDescription ( ) const
pure virtual

Stop condition return string type

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

◆ GetValue()

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 >.

◆ GetWeights()

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.

◆ GetWeightsAreIdentity()

template<typename TInternalComputationValueType = double>
virtual const bool& itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::GetWeightsAreIdentity ( ) const
virtual

Get whether weights are identity. Cannot be set

◆ PrintSelf()

template<typename TInternalComputationValueType = double>
void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

Reimplemented from itk::Object.

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

◆ SetDoEstimateScales()

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.

◆ SetMetric()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetMetric ( MetricType *  _arg)
virtual

Accessors for Metric

◆ SetNumberOfIterations()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetNumberOfIterations ( SizeValueType  _arg)
virtual

Set the number of iterations.

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

◆ SetNumberOfWorkUnits()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetNumberOfWorkUnits ( ThreadIdType  number)
virtual

Set the number of work units to use when threading. The default is the global default number of work units decided in the constructor of the MultiThreader.

◆ SetScales()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetScales ( const ScalesType &  scales)
inlinevirtual

Set current parameters scaling.

Definition at line 174 of file itkObjectToObjectOptimizerBase.h.

◆ SetScalesEstimator()

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

◆ SetWeights()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::SetWeights ( ScalesType  _arg)
virtual

Set current parameters weights.

◆ StartOptimization()

template<typename TInternalComputationValueType = double>
virtual void itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::StartOptimization ( bool  doOnlyInitialization = false)
virtual

Run the optimization.

Parameters
doOnlyInitializationThis 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::LBFGS2Optimizerv4, itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, itk::OnePlusOneEvolutionaryOptimizerv4< TInternalComputationValueType >, itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >, itk::PowellOptimizerv4< TInternalComputationValueType >, itk::LBFGSBOptimizerv4, itk::MultiStartOptimizerv4Template< TInternalComputationValueType >, itk::ExhaustiveOptimizerv4< TInternalComputationValueType >, itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >, itk::LBFGSOptimizerv4, itk::LBFGSOptimizerBasev4< TInternalVnlOptimizerType >, 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

◆ m_CurrentIteration

template<typename TInternalComputationValueType = double>
SizeValueType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_CurrentIteration
protected

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

Definition at line 277 of file itkObjectToObjectOptimizerBase.h.

◆ m_CurrentMetricValue

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

◆ m_DoEstimateScales

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

◆ m_Metric

template<typename TInternalComputationValueType = double>
MetricTypePointer itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_Metric
protected

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

Definition at line 275 of file itkObjectToObjectOptimizerBase.h.

◆ m_NumberOfIterations

template<typename TInternalComputationValueType = double>
SizeValueType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_NumberOfIterations
protected

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

Definition at line 278 of file itkObjectToObjectOptimizerBase.h.

◆ m_NumberOfWorkUnits

template<typename TInternalComputationValueType = double>
ThreadIdType itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_NumberOfWorkUnits
protected

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

Definition at line 276 of file itkObjectToObjectOptimizerBase.h.

◆ m_Scales

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

◆ m_ScalesAreIdentity

template<typename TInternalComputationValueType = double>
bool itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_ScalesAreIdentity
protected

Flag to avoid unnecessary arithmetic when scales are identity.

Definition at line 294 of file itkObjectToObjectOptimizerBase.h.

◆ m_ScalesEstimator

template<typename TInternalComputationValueType = double>
ScalesEstimatorType::Pointer itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_ScalesEstimator
protected

Scales estimator. Optionally provided by user.

Definition at line 297 of file itkObjectToObjectOptimizerBase.h.

◆ m_Weights

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

◆ m_WeightsAreIdentity

template<typename TInternalComputationValueType = double>
bool itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >::m_WeightsAreIdentity
protected

Flag to avoid unnecessary arithmetic when weights are identity.

Definition at line 300 of file itkObjectToObjectOptimizerBase.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Thu Apr 1 2021 02:30:28 for ITK by   doxygen 1.8.16