itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType > Class Template Reference

#include <itkOptimizerParameterScalesEstimator.h>

Inheritance diagram for itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >:

Collaboration diagram for itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	FloatType = TInternalComputationValueType
using	ParametersType = OptimizerParameters< TInternalComputationValueType >
using	Pointer = SmartPointer< Self >
using	ScalesType = OptimizerParameters< TInternalComputationValueType >
using	Self = OptimizerParameterScalesEstimatorTemplate
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 void	EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)=0
virtual FloatType	EstimateMaximumStepSize ()=0
virtual void	EstimateScales (ScalesType &scales)=0
virtual FloatType	EstimateStepScale (const ParametersType &step)=0
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

Protected Member Functions
	OptimizerParameterScalesEstimatorTemplate ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~OptimizerParameterScalesEstimatorTemplate () override=default
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 ()

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 Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

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

OptimizerParameterScalesEstimatorTemplate is the base class offering a empty method of estimating the parameter scales for optimizers.

Its subclass RegistrationParameterScalesEstimator estimates scales for registration optimizers.

Definition at line 39 of file itkOptimizerParameterScalesEstimator.h.

Member Typedef Documentation

ConstPointer

template<typename TInternalComputationValueType = double>

using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 48 of file itkOptimizerParameterScalesEstimator.h.

FloatType

template<typename TInternalComputationValueType = double>

using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::FloatType = TInternalComputationValueType

Type of float

Definition at line 60 of file itkOptimizerParameterScalesEstimator.h.

ParametersType

template<typename TInternalComputationValueType = double>

using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::ParametersType = OptimizerParameters<TInternalComputationValueType>

Type of parameters of the optimizer

Definition at line 57 of file itkOptimizerParameterScalesEstimator.h.

Pointer

template<typename TInternalComputationValueType = double>

using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 47 of file itkOptimizerParameterScalesEstimator.h.

ScalesType

template<typename TInternalComputationValueType = double>

using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::ScalesType = OptimizerParameters<TInternalComputationValueType>

Type of scales

Definition at line 54 of file itkOptimizerParameterScalesEstimator.h.

Self

template<typename TInternalComputationValueType = double>

using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::Self = OptimizerParameterScalesEstimatorTemplate

Standard class type aliases.

Definition at line 45 of file itkOptimizerParameterScalesEstimator.h.

Superclass

template<typename TInternalComputationValueType = double>

using itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::Superclass = Object

Definition at line 46 of file itkOptimizerParameterScalesEstimator.h.

Constructor & Destructor Documentation

OptimizerParameterScalesEstimatorTemplate()

template<typename TInternalComputationValueType = double>

itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::OptimizerParameterScalesEstimatorTemplate ( )

protecteddefault

~OptimizerParameterScalesEstimatorTemplate()

template<typename TInternalComputationValueType = double>

itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::~OptimizerParameterScalesEstimatorTemplate ( )

overrideprotecteddefault

Member Function Documentation

EstimateLocalStepScales()

template<typename TInternalComputationValueType = double>

virtual void itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::EstimateLocalStepScales ( const ParametersType &  step, ScalesType &  localStepScales  )

pure virtual

Estimate the scales of local steps.

EstimateMaximumStepSize()

template<typename TInternalComputationValueType = double>

virtual FloatType itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::EstimateMaximumStepSize ( )

pure virtual

Estimate the maximum size for steps.

Implemented in itk::RegistrationParameterScalesEstimator< TMetric >.

EstimateScales()

template<typename TInternalComputationValueType = double>

virtual void itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::EstimateScales ( ScalesType &  scales )

pure virtual

Estimate parameter scales.

EstimateStepScale()

template<typename TInternalComputationValueType = double>

virtual FloatType itk::OptimizerParameterScalesEstimatorTemplate< TInternalComputationValueType >::EstimateStepScale ( const ParametersType &  step )

pure virtual

Estimate the scale of a step.

GetNameOfClass()

template<typename TInternalComputationValueType = double>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::RegistrationParameterScalesEstimator< TMetric >, itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

PrintSelf()

template<typename TInternalComputationValueType = double>

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

inlineoverrideprotectedvirtual

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.

Definition at line 83 of file itkOptimizerParameterScalesEstimator.h.

---

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

• itkOptimizerParameterScalesEstimator.h