ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members

#include <itkRegularStepGradientDescentOptimizer.h>

+ Inheritance diagram for itk::RegularStepGradientDescentOptimizer:
+ Collaboration diagram for itk::RegularStepGradientDescentOptimizer:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CostFunctionPointer = CostFunctionType::Pointer
 
using CostFunctionType = Superclass::CostFunctionType
 
using Pointer = SmartPointer< Self >
 
using Self = RegularStepGradientDescentOptimizer
 
using Superclass = RegularStepGradientDescentBaseOptimizer
 
- Public Types inherited from itk::RegularStepGradientDescentBaseOptimizer
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::RegularStepGradientDescentBaseOptimizer
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 SizeValueTypeGetNumberOfIterations () const
 
virtual const double & GetGradientMagnitudeTolerance () const
 
virtual unsigned int GetCurrentIteration () const
 
virtual const StopConditionEnumGetStopCondition () const
 
virtual const MeasureTypeGetValue () const
 
virtual const DerivativeTypeGetGradient () const
 
const std::string GetStopConditionDescription () const override
 
- Public Member Functions inherited from itk::SingleValuedNonLinearOptimizer
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const CostFunctionTypeGetCostFunction () const
 
virtual CostFunctionTypeGetModifiableCostFunction ()
 
MeasureType GetValue (const ParametersType &parameters) const
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
- Public Member Functions inherited from itk::Optimizer
virtual const ParametersTypeGetInitialPosition () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () const
 
virtual const ParametersTypeGetCurrentPosition () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 RegularStepGradientDescentOptimizer ()=default
 
void StepAlongGradient (double factor, const DerivativeType &transformedGradient) override
 
 ~RegularStepGradientDescentOptimizer () override=default
 
- Protected Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
 RegularStepGradientDescentBaseOptimizer ()
 
 ~RegularStepGradientDescentBaseOptimizer () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void AdvanceOneStep ()
 
- 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 &time)
 
- 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

- Protected Attributes inherited from itk::RegularStepGradientDescentBaseOptimizer
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
 
- 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.

Examples
Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesAffine/Code.cxx, SphinxExamples/src/Registration/Common/GlobalRegistrationOfTwoImages/Code.cxx, and SphinxExamples/src/Registration/Common/WatchRegistration/Code.cxx.

Definition at line 33 of file itkRegularStepGradientDescentOptimizer.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 42 of file itkRegularStepGradientDescentOptimizer.h.

◆ CostFunctionPointer

Definition at line 52 of file itkRegularStepGradientDescentOptimizer.h.

◆ CostFunctionType

using itk::RegularStepGradientDescentOptimizer::CostFunctionType = Superclass::CostFunctionType

Cost function type alias.

Definition at line 51 of file itkRegularStepGradientDescentOptimizer.h.

◆ Pointer

Definition at line 41 of file itkRegularStepGradientDescentOptimizer.h.

◆ Self

Standard class type aliases.

Definition at line 39 of file itkRegularStepGradientDescentOptimizer.h.

◆ Superclass

Definition at line 40 of file itkRegularStepGradientDescentOptimizer.h.

Constructor & Destructor Documentation

◆ RegularStepGradientDescentOptimizer()

itk::RegularStepGradientDescentOptimizer::RegularStepGradientDescentOptimizer ( )
protecteddefault

◆ ~RegularStepGradientDescentOptimizer()

itk::RegularStepGradientDescentOptimizer::~RegularStepGradientDescentOptimizer ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::RegularStepGradientDescentOptimizer::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::RegularStepGradientDescentBaseOptimizer.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

◆ New()

static Pointer itk::RegularStepGradientDescentOptimizer::New ( )
static

Method for creation through the object factory.

◆ StepAlongGradient()

void itk::RegularStepGradientDescentOptimizer::StepAlongGradient ( double  factor,
const DerivativeType transformedGradient 
)
overrideprotectedvirtual

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 from itk::RegularStepGradientDescentBaseOptimizer.


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