ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::RegularStepGradientDescentOptimizer Class Reference

#include <itkRegularStepGradientDescentOptimizer.h>

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

Detailed Description

Implement a gradient descent optimizer.

Examples:
Examples/RegistrationITKv3/DeformableRegistration13.cxx, Examples/RegistrationITKv3/DeformableRegistration14.cxx, Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/ImageRegistration1.cxx, Examples/RegistrationITKv3/ImageRegistration12.cxx, Examples/RegistrationITKv3/ImageRegistration13.cxx, Examples/RegistrationITKv3/ImageRegistration18.cxx, Examples/RegistrationITKv3/ImageRegistration20.cxx, Examples/RegistrationITKv3/ImageRegistration3.cxx, Examples/RegistrationITKv3/ImageRegistration4.cxx, Examples/RegistrationITKv3/ImageRegistration5.cxx, Examples/RegistrationITKv3/ImageRegistration6.cxx, Examples/RegistrationITKv3/ImageRegistration7.cxx, Examples/RegistrationITKv3/ImageRegistration9.cxx, Examples/RegistrationITKv3/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv3/ModelToImageRegistration2.cxx, Examples/RegistrationITKv3/MultiResImageRegistration1.cxx, Examples/RegistrationITKv3/MultiResImageRegistration2.cxx, Examples/RegistrationITKv3/MultiResImageRegistration3.cxx, 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, WikiExamples/Registration/ImageRegistrationMethod.cxx, WikiExamples/Registration/ImageRegistrationMethodAffine.cxx, and WikiExamples/Registration/WatchRegistration.cxx.

Definition at line 33 of file itkRegularStepGradientDescentOptimizer.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef
Superclass::CostFunctionType 
CostFunctionType
 
typedef SmartPointer< SelfPointer
 
typedef
RegularStepGradientDescentOptimizer 
Self
 
typedef
RegularStepGradientDescentBaseOptimizer 
Superclass
 
- Public Types inherited from itk::RegularStepGradientDescentBaseOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef
RegularStepGradientDescentBaseOptimizer 
Self
 
enum  StopConditionType {
  GradientMagnitudeTolerance = 1,
  StepTooSmall = 2,
  ImageNotAvailable = 3,
  CostFunctionError = 4,
  MaximumNumberOfIterations = 5,
  Unknown = 6
}
 
typedef
SingleValuedNonLinearOptimizer 
Superclass
 
- Public Types inherited from itk::SingleValuedNonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef CostFunctionType::Pointer CostFunctionPointer
 
typedef SingleValuedCostFunction CostFunctionType
 
typedef
CostFunctionType::DerivativeType 
DerivativeType
 
typedef
CostFunctionType::MeasureType 
MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
SingleValuedNonLinearOptimizer 
Self
 
typedef NonLinearOptimizer Superclass
 
- Public Types inherited from itk::NonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef NonLinearOptimizer Self
 
typedef Optimizer Superclass
 
- Public Types inherited from itk::Optimizer
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Array< double > ScalesType
 
typedef Optimizer Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
virtual const std::string GetStopConditionDescription () const override
 
void ResumeOptimization ()
 
virtual void StartOptimization (void) override
 
void StopOptimization ()
 
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)
 
void MinimizeOff (void)
 
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 StopConditionTypeGetStopCondition () const
 
virtual const MeasureTypeGetValue () const
 
virtual const DerivativeTypeGetGradient () const
 
- 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 ParametersTypeGetCurrentPosition () const
 
virtual const ParametersTypeGetInitialPosition () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
void SetScales (const ScalesType &scales)
 
virtual const ScalesTypeGetScales () const
 
virtual const ScalesTypeGetInverseScales () 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 ()
 
virtual void StepAlongGradient (double factor, const DerivativeType &transformedGradient) override
 
virtual ~RegularStepGradientDescentOptimizer () override
 
- Protected Member Functions inherited from itk::RegularStepGradientDescentBaseOptimizer
virtual void AdvanceOneStep ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 RegularStepGradientDescentBaseOptimizer ()
 
virtual void StepAlongGradient (double, const DerivativeType &)
 
virtual ~RegularStepGradientDescentBaseOptimizer () override
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
 SingleValuedNonLinearOptimizer ()
 
virtual ~SingleValuedNonLinearOptimizer () override
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()
 
virtual ~NonLinearOptimizer () override
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
virtual ~Optimizer () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- 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
SizeValueType m_CurrentIteration
 
double m_CurrentStepLength
 
DerivativeType m_Gradient
 
double m_GradientMagnitudeTolerance
 
bool m_Maximize
 
double m_MaximumStepLength
 
double m_MinimumStepLength
 
SizeValueType m_NumberOfIterations
 
DerivativeType m_PreviousGradient
 
double m_RelaxationFactor
 
bool m_Stop
 
StopConditionType m_StopCondition
 
std::ostringstream m_StopConditionDescription
 
MeasureType m_Value
 
- Protected Attributes inherited from itk::SingleValuedNonLinearOptimizer
CostFunctionPointer m_CostFunction
 
- Protected Attributes inherited from itk::Optimizer
ParametersType m_CurrentPosition
 
bool m_ScalesInitialized
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

Definition at line 41 of file itkRegularStepGradientDescentOptimizer.h.

Definition at line 52 of file itkRegularStepGradientDescentOptimizer.h.

typedef Superclass::CostFunctionType itk::RegularStepGradientDescentOptimizer::CostFunctionType

Cost function typedefs.

Definition at line 48 of file itkRegularStepGradientDescentOptimizer.h.

Definition at line 40 of file itkRegularStepGradientDescentOptimizer.h.

Standard class typedefs.

Definition at line 38 of file itkRegularStepGradientDescentOptimizer.h.

Definition at line 39 of file itkRegularStepGradientDescentOptimizer.h.

Constructor & Destructor Documentation

itk::RegularStepGradientDescentOptimizer::RegularStepGradientDescentOptimizer ( )
inlineprotected

Definition at line 55 of file itkRegularStepGradientDescentOptimizer.h.

virtual itk::RegularStepGradientDescentOptimizer::~RegularStepGradientDescentOptimizer ( )
inlineoverrideprotectedvirtual

Definition at line 56 of file itkRegularStepGradientDescentOptimizer.h.

Member Function Documentation

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.

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

Run-time type information (and related methods).

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

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

Method for creation through the object factory.

virtual 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 overrided by optimization methods in non-vector spaces

See Also
AdvanceOneStep

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