#include <itkGradientDescentOptimizerBasev4.h>

Inheritance diagram for itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >:

Collaboration diagram for itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ConvergenceMonitoringType = itk::Function::WindowConvergenceMonitoringFunction< TInternalComputationValueType >

using	DerivativeType = typename Superclass::DerivativeType

using	InternalComputationValueType = TInternalComputationValueType

using	MeasureType = typename Superclass::MeasureType

using	MetricType = typename Superclass::MetricType

using	MetricTypePointer = typename MetricType::Pointer

using	ParametersType = typename Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = typename Superclass::ScalesType

using	Self = GradientDescentOptimizerBasev4Template

using	StopConditionDescriptionType = typename Superclass::StopConditionDescriptionType

using	StopConditionReturnStringType = typename Superclass::StopConditionReturnStringType

using	Superclass = ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >

Public Types inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
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 DerivativeType &	GetGradient () const

virtual const char *	GetNameOfClass () const

virtual const StopConditionObjectToObjectOptimizerEnum &	GetStopCondition () const

Public Member Functions inherited from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
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 const ParametersType &	GetCurrentPosition () 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

using	IndexRangeType = ThreadedIndexedContainerPartitioner::IndexRangeType

bool	m_DoEstimateLearningRateAtEachIteration

bool	m_DoEstimateLearningRateOnce

TInternalComputationValueType	m_MaximumStepSizeInPhysicalUnits

bool	m_UseConvergenceMonitoring

SizeValueType	m_ConvergenceWindowSize

ConvergenceMonitoringType::Pointer	m_ConvergenceMonitoring

DomainThreader< ThreadedIndexedContainerPartitioner, Self >::Pointer	m_ModifyGradientByScalesThreader

DomainThreader< ThreadedIndexedContainerPartitioner, Self >::Pointer	m_ModifyGradientByLearningRateThreader

bool	m_Stop { false }

StopConditionObjectToObjectOptimizerEnum	m_StopCondition

StopConditionDescriptionType	m_StopConditionDescription

DerivativeType	m_Gradient

void	SetNumberOfIterations (const SizeValueType numberOfIterations) override

SizeValueType	GetNumberOfIterations () const override

SizeValueType	GetCurrentIteration () const override

void	StartOptimization (bool doOnlyInitialization=false) override

virtual void	ResumeOptimization ()=0

virtual void	StopOptimization ()

const StopConditionReturnStringType	GetStopConditionDescription () const override

virtual void	ModifyGradientByScales ()

virtual void	ModifyGradientByLearningRate ()

virtual void	ModifyGradientByScalesOverSubRange (const IndexRangeType &subrange)=0

virtual void	ModifyGradientByLearningRateOverSubRange (const IndexRangeType &subrange)=0

	GradientDescentOptimizerBasev4Template ()

	~GradientDescentOptimizerBasev4Template () override=default

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::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
	ObjectToObjectOptimizerBaseTemplate ()

	~ObjectToObjectOptimizerBaseTemplate () override

void	PrintSelf (std::ostream &os, Indent indent) const override

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::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >
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

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<typename TInternalComputationValueType>
class itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >

Definition at line 40 of file itkGradientDescentOptimizerBasev4.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInternalComputationValueType >

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

Definition at line 50 of file itkGradientDescentOptimizerBasev4.h.

◆ ConvergenceMonitoringType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ConvergenceMonitoringType = itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType>

Type for the convergence checker

Definition at line 97 of file itkGradientDescentOptimizerBasev4.h.

◆ DerivativeType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::DerivativeType = typename Superclass::DerivativeType

Derivative type

Definition at line 87 of file itkGradientDescentOptimizerBasev4.h.

◆ IndexRangeType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::IndexRangeType = ThreadedIndexedContainerPartitioner::IndexRangeType

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Definition at line 169 of file itkGradientDescentOptimizerBasev4.h.

◆ InternalComputationValueType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::InternalComputationValueType = TInternalComputationValueType

It should be possible to derive the internal computation type from the class object.

Definition at line 80 of file itkGradientDescentOptimizerBasev4.h.

◆ MeasureType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::MeasureType = typename Superclass::MeasureType

Measure type

Definition at line 90 of file itkGradientDescentOptimizerBasev4.h.

◆ MetricType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::MetricType = typename Superclass::MetricType

Metric type over which this class is templated

Definition at line 83 of file itkGradientDescentOptimizerBasev4.h.

◆ MetricTypePointer

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::MetricTypePointer = typename MetricType::Pointer

Definition at line 84 of file itkGradientDescentOptimizerBasev4.h.

◆ ParametersType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ParametersType = typename Superclass::ParametersType

Definition at line 94 of file itkGradientDescentOptimizerBasev4.h.

◆ Pointer

template<typename TInternalComputationValueType >

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

Definition at line 49 of file itkGradientDescentOptimizerBasev4.h.

◆ ScalesType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ScalesType = typename Superclass::ScalesType

Definition at line 92 of file itkGradientDescentOptimizerBasev4.h.

◆ Self

template<typename TInternalComputationValueType >

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

Standard class type aliases.

Definition at line 47 of file itkGradientDescentOptimizerBasev4.h.

◆ StopConditionDescriptionType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::StopConditionDescriptionType = typename Superclass::StopConditionDescriptionType

Stop condition internal string type

Definition at line 77 of file itkGradientDescentOptimizerBasev4.h.

◆ StopConditionReturnStringType

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::StopConditionReturnStringType = typename Superclass::StopConditionReturnStringType

Stop condition return string type

Definition at line 74 of file itkGradientDescentOptimizerBasev4.h.

◆ Superclass

template<typename TInternalComputationValueType >

using itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::Superclass = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>

Definition at line 48 of file itkGradientDescentOptimizerBasev4.h.

Constructor & Destructor Documentation

◆ GradientDescentOptimizerBasev4Template()

template<typename TInternalComputationValueType >

itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::GradientDescentOptimizerBasev4Template ( )

protected

Default constructor

◆ ~GradientDescentOptimizerBasev4Template()

template<typename TInternalComputationValueType >

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

overrideprotecteddefault

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Member Function Documentation

◆ GetCurrentIteration()

template<typename TInternalComputationValueType >

SizeValueType itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::GetCurrentIteration ( ) const

inlineoverridevirtual

Get the current iteration number.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

Definition at line 127 of file itkGradientDescentOptimizerBasev4.h.

◆ GetGradient()

template<typename TInternalComputationValueType >

virtual const DerivativeType& itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::GetGradient ( ) const

virtual

Get the most recent gradient values.

◆ GetNameOfClass()

template<typename TInternalComputationValueType >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

Reimplemented in itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, itk::QuasiNewtonOptimizerv4Template< TInternalComputationValueType >, itk::GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType >, itk::ConjugateGradientLineSearchOptimizerv4Template< TInternalComputationValueType >, itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >, and itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >.

◆ GetNumberOfIterations()

template<typename TInternalComputationValueType >

SizeValueType itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::GetNumberOfIterations ( ) const

inlineoverridevirtual

Get the number of iterations.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

Definition at line 120 of file itkGradientDescentOptimizerBasev4.h.

◆ GetStopCondition()

template<typename TInternalComputationValueType >

virtual const StopConditionObjectToObjectOptimizerEnum& itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::GetStopCondition ( ) const

virtual

Get stop condition enum

Reimplemented in itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >.

◆ GetStopConditionDescription()

template<typename TInternalComputationValueType >

const StopConditionReturnStringType itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::GetStopConditionDescription ( ) const

overridevirtual

Get the reason for termination

Implements itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

Reimplemented in itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >.

◆ ModifyGradientByLearningRate()

template<typename TInternalComputationValueType >

virtual void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ModifyGradientByLearningRate ( )

virtual

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

◆ ModifyGradientByLearningRateOverSubRange()

template<typename TInternalComputationValueType >

virtual void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ModifyGradientByLearningRateOverSubRange ( const IndexRangeType & subrange )

pure virtual

Derived classes define this worker method to modify the gradient by learning rates. Modifications must be performed over the index range defined in subrange. Called from ModifyGradientByLearningRate(), either directly or via threaded operation. This function is used in GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate and GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate classes.

Implemented in itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, and itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >.

◆ ModifyGradientByScales()

template<typename TInternalComputationValueType >

virtual void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ModifyGradientByScales ( )

virtual

Modify the gradient in place, to advance the optimization. This call performs a threaded modification for transforms with local support (assumed to be dense). Otherwise the modification is performed w/out threading. See EstimateLearningRate() to perform optionally learning rate estimation. At completion, m_Gradient can be used to update the transform parameters. Derived classes may hold additional results in other member variables.

See also: EstimateLearningRate()

◆ ModifyGradientByScalesOverSubRange()

template<typename TInternalComputationValueType >

virtual void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ModifyGradientByScalesOverSubRange ( const IndexRangeType & subrange )

pure virtual

Derived classes define this worker method to modify the gradient by scales. Modifications must be performed over the index range defined in subrange. Called from ModifyGradientByScales(), either directly or via threaded operation.

Implemented in itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, and itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >.

◆ PrintSelf()

template<typename TInternalComputationValueType >

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

overrideprotectedvirtual

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Reimplemented from itk::Object.

Reimplemented in itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, itk::QuasiNewtonOptimizerv4Template< TInternalComputationValueType >, itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >, and itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >.

◆ ResumeOptimization()

template<typename TInternalComputationValueType >

virtual void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::ResumeOptimization ( )

pure virtual

Resume optimization. This runs the optimization loop, and allows continuation of stopped optimization

Implemented in itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, and itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >.

◆ SetNumberOfIterations()

template<typename TInternalComputationValueType >

void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::SetNumberOfIterations ( const SizeValueType numberOfIterations )

inlineoverridevirtual

Set the number of iterations.

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

Definition at line 107 of file itkGradientDescentOptimizerBasev4.h.

◆ StartOptimization()

template<typename TInternalComputationValueType >

void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::StartOptimization ( bool doOnlyInitialization = false )

overridevirtual

Start and run the optimization

Reimplemented from itk::ObjectToObjectOptimizerBaseTemplate< TInternalComputationValueType >.

Reimplemented in itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, itk::RegularStepGradientDescentOptimizerv4< TInternalComputationValueType >, itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >, and itk::QuasiNewtonOptimizerv4Template< TInternalComputationValueType >.

◆ StopOptimization()

template<typename TInternalComputationValueType >

virtual void itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::StopOptimization ( )

virtual

Stop optimization. The object is left in a state so the optimization can be resumed by calling ResumeOptimization.

Reimplemented in itk::GradientDescentOptimizerv4Template< TInternalComputationValueType >, and itk::MultiGradientOptimizerv4Template< TInternalComputationValueType >.

Member Data Documentation

◆ m_ConvergenceMonitoring

template<typename TInternalComputationValueType >

ConvergenceMonitoringType::Pointer itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_ConvergenceMonitoring

protected

The convergence checker.

Definition at line 227 of file itkGradientDescentOptimizerBasev4.h.

◆ m_ConvergenceWindowSize

template<typename TInternalComputationValueType >

SizeValueType itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_ConvergenceWindowSize

protected

Window size for the convergence checker. The convergence checker calculates convergence value by fitting to a window of the energy (metric value) profile.

Definition at line 224 of file itkGradientDescentOptimizerBasev4.h.

◆ m_DoEstimateLearningRateAtEachIteration

template<typename TInternalComputationValueType >

bool itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_DoEstimateLearningRateAtEachIteration

protected

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Definition at line 199 of file itkGradientDescentOptimizerBasev4.h.

◆ m_DoEstimateLearningRateOnce

template<typename TInternalComputationValueType >

bool itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_DoEstimateLearningRateOnce

protected

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation only once, during first iteration.

Definition at line 204 of file itkGradientDescentOptimizerBasev4.h.

◆ m_Gradient

template<typename TInternalComputationValueType >

DerivativeType itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_Gradient

protected

Current gradient

Definition at line 238 of file itkGradientDescentOptimizerBasev4.h.

◆ m_MaximumStepSizeInPhysicalUnits

template<typename TInternalComputationValueType >

TInternalComputationValueType itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_MaximumStepSizeInPhysicalUnits

protected

The maximum step size in physical units, to restrict learning rates. Only used with automatic learning rate estimation. It may be initialized either by calling SetMaximumStepSizeInPhysicalUnits manually or by using m_ScalesEstimator automatically, and the former has higher priority than the latter. See main documentation.

Definition at line 212 of file itkGradientDescentOptimizerBasev4.h.

◆ m_ModifyGradientByLearningRateThreader

template<typename TInternalComputationValueType >

DomainThreader<ThreadedIndexedContainerPartitioner, Self>::Pointer itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_ModifyGradientByLearningRateThreader

protected

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Definition at line 230 of file itkGradientDescentOptimizerBasev4.h.

◆ m_ModifyGradientByScalesThreader

template<typename TInternalComputationValueType >

DomainThreader<ThreadedIndexedContainerPartitioner, Self>::Pointer itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_ModifyGradientByScalesThreader

protected

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Definition at line 229 of file itkGradientDescentOptimizerBasev4.h.

◆ m_Stop

template<typename TInternalComputationValueType >

bool itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_Stop { false }

protected

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Definition at line 233 of file itkGradientDescentOptimizerBasev4.h.

◆ m_StopCondition

template<typename TInternalComputationValueType >

StopConditionObjectToObjectOptimizerEnum itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_StopCondition

protected

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Definition at line 234 of file itkGradientDescentOptimizerBasev4.h.

◆ m_StopConditionDescription

template<typename TInternalComputationValueType >

StopConditionDescriptionType itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_StopConditionDescription

protected

Flag to control use of the ScalesEstimator (if set) for automatic learning step estimation at each iteration.

Definition at line 235 of file itkGradientDescentOptimizerBasev4.h.

◆ m_UseConvergenceMonitoring

template<typename TInternalComputationValueType >

bool itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >::m_UseConvergenceMonitoring

protected

Flag to control using the convergence monitoring for stop condition. This flag should be always set to true except for regular step gradient descent optimizer that uses minimum step length to check the convergence.

Definition at line 218 of file itkGradientDescentOptimizerBasev4.h.

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

itkGradientDescentOptimizerBasev4.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename TInternalComputationValueType> class itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >

Member Typedef Documentation

◆ ConstPointer

◆ ConvergenceMonitoringType

◆ DerivativeType

◆ IndexRangeType

◆ InternalComputationValueType

◆ MeasureType

◆ MetricType

◆ MetricTypePointer

◆ ParametersType

◆ Pointer

◆ ScalesType

◆ Self

◆ StopConditionDescriptionType

◆ StopConditionReturnStringType

◆ Superclass

Constructor & Destructor Documentation

◆ GradientDescentOptimizerBasev4Template()

◆ ~GradientDescentOptimizerBasev4Template()

Member Function Documentation

◆ GetCurrentIteration()

◆ GetGradient()

◆ GetNameOfClass()

◆ GetNumberOfIterations()

◆ GetStopCondition()

◆ GetStopConditionDescription()

◆ ModifyGradientByLearningRate()

◆ ModifyGradientByLearningRateOverSubRange()

◆ ModifyGradientByScales()

◆ ModifyGradientByScalesOverSubRange()

◆ PrintSelf()

◆ ResumeOptimization()

◆ SetNumberOfIterations()

◆ StartOptimization()

◆ StopOptimization()

Member Data Documentation

◆ m_ConvergenceMonitoring

◆ m_ConvergenceWindowSize

◆ m_DoEstimateLearningRateAtEachIteration

◆ m_DoEstimateLearningRateOnce

◆ m_Gradient

◆ m_MaximumStepSizeInPhysicalUnits

◆ m_ModifyGradientByLearningRateThreader

◆ m_ModifyGradientByScalesThreader

◆ m_Stop

◆ m_StopCondition

◆ m_StopConditionDescription

◆ m_UseConvergenceMonitoring

template<typename TInternalComputationValueType>
class itk::GradientDescentOptimizerBasev4Template< TInternalComputationValueType >