ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::RegularStepGradientDescentBaseOptimizer Class Reference

#include <itkRegularStepGradientDescentBaseOptimizer.h>

+ Inheritance diagram for itk::RegularStepGradientDescentBaseOptimizer:
+ Collaboration diagram for itk::RegularStepGradientDescentBaseOptimizer:

Detailed Description

Implement a gradient descent optimizer.

Definition at line 33 of file itkRegularStepGradientDescentBaseOptimizer.h.

Public Types

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

virtual void AdvanceOneStep ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 RegularStepGradientDescentBaseOptimizer ()
 
virtual void StepAlongGradient (double, const DerivativeType &)
 
virtual ~RegularStepGradientDescentBaseOptimizer ()
 
- Protected Member Functions inherited from itk::SingleValuedNonLinearOptimizer
 SingleValuedNonLinearOptimizer ()
 
virtual ~SingleValuedNonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::NonLinearOptimizer
 NonLinearOptimizer ()
 
virtual ~NonLinearOptimizer ()
 
- Protected Member Functions inherited from itk::Optimizer
 Optimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
virtual ~Optimizer ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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

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
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 RegularStepGradientDescentBaseOptimizer (const Self &) ITK_DELETE_FUNCTION
 

Member Typedef Documentation

Definition at line 41 of file itkRegularStepGradientDescentBaseOptimizer.h.

Definition at line 40 of file itkRegularStepGradientDescentBaseOptimizer.h.

Standard "Self" typedef.

Definition at line 38 of file itkRegularStepGradientDescentBaseOptimizer.h.

Definition at line 39 of file itkRegularStepGradientDescentBaseOptimizer.h.

Member Enumeration Documentation

Codes of stopping conditions.

Enumerator
GradientMagnitudeTolerance 
StepTooSmall 
ImageNotAvailable 
CostFunctionError 
MaximumNumberOfIterations 
Unknown 

Definition at line 51 of file itkRegularStepGradientDescentBaseOptimizer.h.

Constructor & Destructor Documentation

itk::RegularStepGradientDescentBaseOptimizer::RegularStepGradientDescentBaseOptimizer ( )
protected
virtual itk::RegularStepGradientDescentBaseOptimizer::~RegularStepGradientDescentBaseOptimizer ( )
inlineprotectedvirtual
itk::RegularStepGradientDescentBaseOptimizer::RegularStepGradientDescentBaseOptimizer ( const Self )
private

Member Function Documentation

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.

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.

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

Set/Get parameters to control the optimization process.

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

Set/Get parameters to control the optimization process.

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

Set/Get parameters to control the optimization process.

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

Set/Get parameters to control the optimization process.

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

Specify whether to minimize or maximize the cost function.

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

Set/Get parameters to control the optimization process.

bool itk::RegularStepGradientDescentBaseOptimizer::GetMinimize ( ) const
inline

Specify whether to minimize or maximize the cost function.

Definition at line 64 of file itkRegularStepGradientDescentBaseOptimizer.h.

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

Set/Get parameters to control the optimization process.

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.

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

Set/Get parameters to control the optimization process.

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

Set/Get parameters to control the optimization process.

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

Set/Get parameters to control the optimization process.

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

Get the reason for termination

Reimplemented from itk::Optimizer.

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

Set/Get parameters to control the optimization process.

virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOff ( )
virtual

Specify whether to minimize or maximize the cost function.

virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOn ( )
virtual

Specify whether to minimize or maximize the cost function.

void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOff ( void  )
inline

Specify whether to minimize or maximize the cost function.

Definition at line 70 of file itkRegularStepGradientDescentBaseOptimizer.h.

void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOn ( void  )
inline

Specify whether to minimize or maximize the cost function.

Definition at line 68 of file itkRegularStepGradientDescentBaseOptimizer.h.

static Pointer itk::RegularStepGradientDescentBaseOptimizer::New ( )
static

Method for creation through the object factory.

void itk::RegularStepGradientDescentBaseOptimizer::operator= ( const Self )
private
virtual void itk::RegularStepGradientDescentBaseOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::SingleValuedNonLinearOptimizer.

void itk::RegularStepGradientDescentBaseOptimizer::ResumeOptimization ( )

Resume previously stopped optimization with current parameters.

See Also
StopOptimization
virtual void itk::RegularStepGradientDescentBaseOptimizer::SetGradientMagnitudeTolerance ( double  _arg)
virtual

Set/Get parameters to control the optimization process.

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

Specify whether to minimize or maximize the cost function.

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

Set/Get parameters to control the optimization process.

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

Specify whether to minimize or maximize the cost function.

Definition at line 66 of file itkRegularStepGradientDescentBaseOptimizer.h.

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

Set/Get parameters to control the optimization process.

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

Set/Get parameters to control the optimization process.

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

Set/Get parameters to control the optimization process.

virtual void itk::RegularStepGradientDescentBaseOptimizer::StartOptimization ( void  )
overridevirtual

Start optimization.

Reimplemented from itk::Optimizer.

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

See Also
AdvanceOneStep

Definition at line 121 of file itkRegularStepGradientDescentBaseOptimizer.h.

References itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

void itk::RegularStepGradientDescentBaseOptimizer::StopOptimization ( )

Stop optimization.

See Also
ResumeOptimization

Member Data Documentation

SizeValueType itk::RegularStepGradientDescentBaseOptimizer::m_CurrentIteration
protected
double itk::RegularStepGradientDescentBaseOptimizer::m_CurrentStepLength
protected
DerivativeType itk::RegularStepGradientDescentBaseOptimizer::m_Gradient
protected
double itk::RegularStepGradientDescentBaseOptimizer::m_GradientMagnitudeTolerance
protected
bool itk::RegularStepGradientDescentBaseOptimizer::m_Maximize
protected
double itk::RegularStepGradientDescentBaseOptimizer::m_MaximumStepLength
protected
double itk::RegularStepGradientDescentBaseOptimizer::m_MinimumStepLength
protected
SizeValueType itk::RegularStepGradientDescentBaseOptimizer::m_NumberOfIterations
protected
DerivativeType itk::RegularStepGradientDescentBaseOptimizer::m_PreviousGradient
protected
double itk::RegularStepGradientDescentBaseOptimizer::m_RelaxationFactor
protected
bool itk::RegularStepGradientDescentBaseOptimizer::m_Stop
protected
StopConditionType itk::RegularStepGradientDescentBaseOptimizer::m_StopCondition
protected
std::ostringstream itk::RegularStepGradientDescentBaseOptimizer::m_StopConditionDescription
protected
MeasureType itk::RegularStepGradientDescentBaseOptimizer::m_Value
protected

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