#include <itkRegularStepGradientDescentBaseOptimizer.h>

Inheritance diagram for itk::RegularStepGradientDescentBaseOptimizer:

Collaboration diagram for itk::RegularStepGradientDescentBaseOptimizer:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = RegularStepGradientDescentBaseOptimizer

using	StopConditionEnum = RegularStepGradientDescentBaseOptimizerEnums::StopCondition

using	Superclass = SingleValuedNonLinearOptimizer

Public Types inherited from itk::SingleValuedNonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >

using	CostFunctionPointer = CostFunctionType::Pointer

using	CostFunctionType = SingleValuedCostFunction

using	DerivativeType = CostFunctionType::DerivativeType

using	MeasureType = CostFunctionType::MeasureType

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = SingleValuedNonLinearOptimizer

using	Superclass = NonLinearOptimizer

Public Types inherited from itk::NonLinearOptimizer
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	ScalesType = Superclass::ScalesType

using	Self = NonLinearOptimizer

using	Superclass = Optimizer

Public Types inherited from itk::Optimizer
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = OptimizerParameters< double >

using	Pointer = SmartPointer< Self >

using	ScalesType = Array< double >

using	Self = Optimizer

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 ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const CostFunctionType *	GetCostFunction () const

virtual CostFunctionType *	GetModifiableCostFunction ()

MeasureType	GetValue (const ParametersType &parameters) const

virtual void	SetCostFunction (CostFunctionType *costFunction)

Public Member Functions inherited from itk::Optimizer
virtual const ParametersType &	GetInitialPosition () const

virtual void	SetInitialPosition (const ParametersType &param)

void	SetScales (const ScalesType &scales)

virtual const ScalesType &	GetScales () const

virtual const ScalesType &	GetInverseScales () 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

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::NonLinearOptimizer
static Pointer	New ()

Static Public Member Functions inherited from itk::Optimizer
static Pointer	New ()

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

DerivativeType	m_Gradient

DerivativeType	m_PreviousGradient

bool	m_Stop { false }

bool	m_Maximize

MeasureType	m_Value

double	m_GradientMagnitudeTolerance

double	m_MaximumStepLength

double	m_MinimumStepLength

double	m_CurrentStepLength

double	m_RelaxationFactor

StopConditionEnum	m_StopCondition

SizeValueType	m_NumberOfIterations

SizeValueType	m_CurrentIteration

std::ostringstream	m_StopConditionDescription

virtual void	SetMaximize (bool _arg)

virtual const bool &	GetMaximize () const

virtual void	MaximizeOn ()

virtual void	MaximizeOff ()

bool	GetMinimize () const

void	SetMinimize (bool v)

void	MinimizeOn ()

void	MinimizeOff ()

void	StartOptimization () override

void	ResumeOptimization ()

void	StopOptimization ()

virtual void	SetMaximumStepLength (double _arg)

virtual void	SetMinimumStepLength (double _arg)

virtual void	SetRelaxationFactor (double _arg)

virtual void	SetNumberOfIterations (SizeValueType _arg)

virtual void	SetGradientMagnitudeTolerance (double _arg)

virtual const double &	GetCurrentStepLength () const

virtual const double &	GetMaximumStepLength () const

virtual const double &	GetMinimumStepLength () const

virtual const double &	GetRelaxationFactor () const

virtual const SizeValueType &	GetNumberOfIterations () const

virtual const double &	GetGradientMagnitudeTolerance () const

virtual unsigned int	GetCurrentIteration () const

virtual const StopConditionEnum &	GetStopCondition () const

virtual const MeasureType &	GetValue () const

virtual const DerivativeType &	GetGradient () const

const std::string	GetStopConditionDescription () const override

	RegularStepGradientDescentBaseOptimizer ()

	~RegularStepGradientDescentBaseOptimizer () override=default

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

virtual void	AdvanceOneStep ()

virtual void	StepAlongGradient (double, const DerivativeType &)

Additional Inherited Members
Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
void	PrintSelf (std::ostream &os, Indent indent) const override

	SingleValuedNonLinearOptimizer ()

	~SingleValuedNonLinearOptimizer () override=default

Protected Member Functions inherited from itk::NonLinearOptimizer
	NonLinearOptimizer ()=default

	~NonLinearOptimizer () override

Protected Member Functions inherited from itk::Optimizer
	Optimizer ()

	~Optimizer () override=default

virtual void	SetCurrentPosition (const ParametersType &param)

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::SingleValuedNonLinearOptimizer
CostFunctionPointer	m_CostFunction

Protected Attributes inherited from itk::Optimizer
bool	m_ScalesInitialized { false }

ParametersType	m_CurrentPosition

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

Detailed Description

Implement a gradient descent optimizer.

Definition at line 58 of file itkRegularStepGradientDescentBaseOptimizer.h.

Member Typedef Documentation

◆ ConstPointer

using itk::RegularStepGradientDescentBaseOptimizer::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ Pointer

using itk::RegularStepGradientDescentBaseOptimizer::Pointer = SmartPointer<Self>

Definition at line 66 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ Self

using itk::RegularStepGradientDescentBaseOptimizer::Self = RegularStepGradientDescentBaseOptimizer

Standard "Self" type alias.

Definition at line 64 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ StopConditionEnum

using itk::RegularStepGradientDescentBaseOptimizer::StopConditionEnum = RegularStepGradientDescentBaseOptimizerEnums::StopCondition

Definition at line 75 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ Superclass

using itk::RegularStepGradientDescentBaseOptimizer::Superclass = SingleValuedNonLinearOptimizer

Definition at line 65 of file itkRegularStepGradientDescentBaseOptimizer.h.

Constructor & Destructor Documentation

◆ RegularStepGradientDescentBaseOptimizer()

itk::RegularStepGradientDescentBaseOptimizer::RegularStepGradientDescentBaseOptimizer ( )

protected

Specify whether to minimize or maximize the cost function.

◆ ~RegularStepGradientDescentBaseOptimizer()

itk::RegularStepGradientDescentBaseOptimizer::~RegularStepGradientDescentBaseOptimizer ( )

overrideprotecteddefault

Specify whether to minimize or maximize the cost function.

Member Function Documentation

◆ AdvanceOneStep()

virtual void itk::RegularStepGradientDescentBaseOptimizer::AdvanceOneStep ( )

protectedvirtual

Advance one step following the gradient direction This method verifies if a change in direction is required and if a reduction in steplength is required.

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::RegularStepGradientDescentBaseOptimizer::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::VersorTransformOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::RegularStepGradientDescentOptimizer.

◆ GetCurrentIteration()

virtual unsigned int itk::RegularStepGradientDescentBaseOptimizer::GetCurrentIteration ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetCurrentStepLength()

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetCurrentStepLength ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetGradient()

virtual const DerivativeType& itk::RegularStepGradientDescentBaseOptimizer::GetGradient ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetGradientMagnitudeTolerance()

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetGradientMagnitudeTolerance ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetMaximize()

virtual const bool& itk::RegularStepGradientDescentBaseOptimizer::GetMaximize ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetMaximumStepLength()

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMaximumStepLength ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetMinimize()

bool itk::RegularStepGradientDescentBaseOptimizer::GetMinimize ( ) const

inline

Specify whether to minimize or maximize the cost function.

Definition at line 91 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ GetMinimumStepLength()

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMinimumStepLength ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetNameOfClass()

virtual const char* itk::RegularStepGradientDescentBaseOptimizer::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Reimplemented in itk::VersorTransformOptimizer, itk::VersorRigid3DTransformOptimizer, and itk::RegularStepGradientDescentOptimizer.

◆ GetNumberOfIterations()

virtual const SizeValueType& itk::RegularStepGradientDescentBaseOptimizer::GetNumberOfIterations ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetRelaxationFactor()

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetRelaxationFactor ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetStopCondition()

virtual const StopConditionEnum& itk::RegularStepGradientDescentBaseOptimizer::GetStopCondition ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ GetStopConditionDescription()

const std::string itk::RegularStepGradientDescentBaseOptimizer::GetStopConditionDescription ( ) const

overridevirtual

Get the reason for termination

Reimplemented from itk::Optimizer.

◆ GetValue()

virtual const MeasureType& itk::RegularStepGradientDescentBaseOptimizer::GetValue ( ) const

virtual

Specify whether to minimize or maximize the cost function.

◆ MaximizeOff()

virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOff ( )

virtual

Specify whether to minimize or maximize the cost function.

◆ MaximizeOn()

virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOn ( )

virtual

Specify whether to minimize or maximize the cost function.

◆ MinimizeOff()

void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOff ( )

inline

Specify whether to minimize or maximize the cost function.

Definition at line 106 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ MinimizeOn()

void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOn ( )

inline

Specify whether to minimize or maximize the cost function.

Definition at line 101 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ New()

static Pointer itk::RegularStepGradientDescentBaseOptimizer::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

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

overrideprotectedvirtual

Specify whether to minimize or maximize the cost function.

Reimplemented from itk::Optimizer.

◆ ResumeOptimization()

void itk::RegularStepGradientDescentBaseOptimizer::ResumeOptimization ( )

Resume previously stopped optimization with current parameters.

See also: StopOptimization

◆ SetGradientMagnitudeTolerance()

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetGradientMagnitudeTolerance ( double _arg )

virtual

Specify whether to minimize or maximize the cost function.

◆ SetMaximize()

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMaximize ( bool _arg )

virtual

Specify whether to minimize or maximize the cost function.

◆ SetMaximumStepLength()

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMaximumStepLength ( double _arg )

virtual

Set/Get parameters to control the optimization process.

◆ SetMinimize()

void itk::RegularStepGradientDescentBaseOptimizer::SetMinimize ( bool v )

inline

Specify whether to minimize or maximize the cost function.

Definition at line 96 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ SetMinimumStepLength()

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMinimumStepLength ( double _arg )

virtual

Specify whether to minimize or maximize the cost function.

◆ SetNumberOfIterations()

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetNumberOfIterations ( SizeValueType _arg )

virtual

Specify whether to minimize or maximize the cost function.

◆ SetRelaxationFactor()

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetRelaxationFactor ( double _arg )

virtual

Specify whether to minimize or maximize the cost function.

◆ StartOptimization()

void itk::RegularStepGradientDescentBaseOptimizer::StartOptimization ( )

overridevirtual

Start optimization.

Reimplemented from itk::Optimizer.

◆ StepAlongGradient()

virtual void itk::RegularStepGradientDescentBaseOptimizer::StepAlongGradient	(	double	,
		const DerivativeType &
	)

inlineprotectedvirtual

Advance one step along the corrected gradient taking into account the steplength represented by factor. This method is invoked by AdvanceOneStep. It is expected to be overridden by optimization methods in non-vector spaces

See also: AdvanceOneStep

Reimplemented in itk::VersorRigid3DTransformOptimizer, itk::VersorTransformOptimizer, and itk::RegularStepGradientDescentOptimizer.

Definition at line 166 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ StopOptimization()

void itk::RegularStepGradientDescentBaseOptimizer::StopOptimization ( )

Stop optimization.

See also: ResumeOptimization

Member Data Documentation

◆ m_CurrentIteration

SizeValueType itk::RegularStepGradientDescentBaseOptimizer::m_CurrentIteration

protected

Specify whether to minimize or maximize the cost function.

Definition at line 190 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_CurrentStepLength

double itk::RegularStepGradientDescentBaseOptimizer::m_CurrentStepLength

protected

Specify whether to minimize or maximize the cost function.

Definition at line 186 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_Gradient

DerivativeType itk::RegularStepGradientDescentBaseOptimizer::m_Gradient

protected

Specify whether to minimize or maximize the cost function.

Definition at line 177 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_GradientMagnitudeTolerance

double itk::RegularStepGradientDescentBaseOptimizer::m_GradientMagnitudeTolerance

protected

Specify whether to minimize or maximize the cost function.

Definition at line 183 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_Maximize

bool itk::RegularStepGradientDescentBaseOptimizer::m_Maximize

protected

Specify whether to minimize or maximize the cost function.

Definition at line 181 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_MaximumStepLength

double itk::RegularStepGradientDescentBaseOptimizer::m_MaximumStepLength

protected

Specify whether to minimize or maximize the cost function.

Definition at line 184 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_MinimumStepLength

double itk::RegularStepGradientDescentBaseOptimizer::m_MinimumStepLength

protected

Specify whether to minimize or maximize the cost function.

Definition at line 185 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_NumberOfIterations

SizeValueType itk::RegularStepGradientDescentBaseOptimizer::m_NumberOfIterations

protected

Specify whether to minimize or maximize the cost function.

Definition at line 189 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_PreviousGradient

DerivativeType itk::RegularStepGradientDescentBaseOptimizer::m_PreviousGradient

protected

Specify whether to minimize or maximize the cost function.

Definition at line 178 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_RelaxationFactor

double itk::RegularStepGradientDescentBaseOptimizer::m_RelaxationFactor

protected

Specify whether to minimize or maximize the cost function.

Definition at line 187 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_Stop

bool itk::RegularStepGradientDescentBaseOptimizer::m_Stop { false }

protected

Specify whether to minimize or maximize the cost function.

Definition at line 180 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_StopCondition

StopConditionEnum itk::RegularStepGradientDescentBaseOptimizer::m_StopCondition

protected

Specify whether to minimize or maximize the cost function.

Definition at line 188 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_StopConditionDescription

std::ostringstream itk::RegularStepGradientDescentBaseOptimizer::m_StopConditionDescription

protected

Specify whether to minimize or maximize the cost function.

Definition at line 191 of file itkRegularStepGradientDescentBaseOptimizer.h.

◆ m_Value

MeasureType itk::RegularStepGradientDescentBaseOptimizer::m_Value

protected

Specify whether to minimize or maximize the cost function.

Definition at line 182 of file itkRegularStepGradientDescentBaseOptimizer.h.

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

itkRegularStepGradientDescentBaseOptimizer.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ StopConditionEnum

◆ Superclass

Constructor & Destructor Documentation

◆ RegularStepGradientDescentBaseOptimizer()

◆ ~RegularStepGradientDescentBaseOptimizer()

Member Function Documentation

◆ AdvanceOneStep()

◆ CreateAnother()

◆ GetCurrentIteration()

◆ GetCurrentStepLength()

◆ GetGradient()

◆ GetGradientMagnitudeTolerance()

◆ GetMaximize()

◆ GetMaximumStepLength()

◆ GetMinimize()

◆ GetMinimumStepLength()

◆ GetNameOfClass()

◆ GetNumberOfIterations()

◆ GetRelaxationFactor()

◆ GetStopCondition()

◆ GetStopConditionDescription()

◆ GetValue()

◆ MaximizeOff()

◆ MaximizeOn()

◆ MinimizeOff()

◆ MinimizeOn()

◆ New()

◆ PrintSelf()

◆ ResumeOptimization()

◆ SetGradientMagnitudeTolerance()

◆ SetMaximize()

◆ SetMaximumStepLength()

◆ SetMinimize()

◆ SetMinimumStepLength()

◆ SetNumberOfIterations()

◆ SetRelaxationFactor()

◆ StartOptimization()

◆ StepAlongGradient()

◆ StopOptimization()

Member Data Documentation

◆ m_CurrentIteration

◆ m_CurrentStepLength

◆ m_Gradient

◆ m_GradientMagnitudeTolerance

◆ m_Maximize

◆ m_MaximumStepLength

◆ m_MinimumStepLength

◆ m_NumberOfIterations

◆ m_PreviousGradient

◆ m_RelaxationFactor

◆ m_Stop

◆ m_StopCondition

◆ m_StopConditionDescription

◆ m_Value