go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::RSGDEachParameterApartBaseOptimizer Class Reference

#include <itkRSGDEachParameterApartBaseOptimizer.h>

Inheritance diagram for itk::RSGDEachParameterApartBaseOptimizer:
Inheritance graph
[legend]
Collaboration diagram for itk::RSGDEachParameterApartBaseOptimizer:
Collaboration graph
[legend]

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef
RSGDEachParameterApartBaseOptimizer 
Self
enum  StopConditionType {
  GradientMagnitudeTolerance = 1, StepTooSmall, ImageNotAvailable, SamplesNotAvailable,
  MaximumNumberOfIterations, MetricError
}
typedef
SingleValuedNonLinearOptimizer 
Superclass

Public Member Functions

virtual const char * GetClassName () const
virtual unsigned long GetCurrentIteration () const
virtual double GetCurrentStepLength () const
virtual const DerivativeType & GetCurrentStepLengths ()
virtual const DerivativeType & GetGradient ()
virtual double GetGradientMagnitude () const
virtual double GetGradientMagnitudeTolerance () const
virtual bool GetMaximize () const
virtual double GetMaximumStepLength () const
bool GetMinimize () const
virtual double GetMinimumStepLength () const
virtual unsigned long GetNumberOfIterations () const
virtual StopConditionType GetStopCondition () const
virtual MeasureType GetValue () const
virtual void MaximizeOff ()
virtual void MaximizeOn ()
void MinimizeOff (void)
void MinimizeOn (void)
void ResumeOptimization (void)
virtual void SetGradientMagnitudeTolerance (double _arg)
virtual void SetMaximize (bool _arg)
virtual void SetMaximumStepLength (double _arg)
void SetMinimize (bool v)
virtual void SetMinimumStepLength (double _arg)
virtual void SetNumberOfIterations (unsigned long _arg)
void StartOptimization (void)
void StopOptimization (void)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual void AdvanceOneStep (void)
void PrintSelf (std::ostream &os, Indent indent) const
 RSGDEachParameterApartBaseOptimizer ()
virtual void StepAlongGradient (const DerivativeType &, const DerivativeType &)
virtual ~RSGDEachParameterApartBaseOptimizer ()

Protected Attributes

unsigned long m_CurrentIteration
double m_CurrentStepLength
DerivativeType m_CurrentStepLengths
DerivativeType m_Gradient
double m_GradientMagnitude
double m_GradientMagnitudeTolerance
bool m_Maximize
double m_MaximumStepLength
double m_MinimumStepLength
unsigned long m_NumberOfIterations
DerivativeType m_PreviousGradient
bool m_Stop
StopConditionType m_StopCondition
MeasureType m_Value

Private Member Functions

void operator= (const Self &)
 RSGDEachParameterApartBaseOptimizer (const Self &)

Detailed Description

An optimizer based on gradient descent...

This optimizer

Definition at line 32 of file itkRSGDEachParameterApartBaseOptimizer.h.


Member Typedef Documentation

Standard "Self" typedef.

Reimplemented in elastix::RSGDEachParameterApart< TElastix >, and itk::RSGDEachParameterApartOptimizer.

Definition at line 37 of file itkRSGDEachParameterApartBaseOptimizer.h.


Member Enumeration Documentation

Codes of stopping conditions.

Enumerator:
GradientMagnitudeTolerance 
StepTooSmall 
ImageNotAvailable 
SamplesNotAvailable 
MaximumNumberOfIterations 
MetricError 

Definition at line 50 of file itkRSGDEachParameterApartBaseOptimizer.h.


Constructor & Destructor Documentation

Definition at line 109 of file itkRSGDEachParameterApartBaseOptimizer.h.


Member Function Documentation

virtual void itk::RSGDEachParameterApartBaseOptimizer::AdvanceOneStep ( void  ) [protected, virtual]

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 const char* itk::RSGDEachParameterApartBaseOptimizer::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented in elastix::RSGDEachParameterApart< TElastix >, and itk::RSGDEachParameterApartOptimizer.

virtual unsigned long itk::RSGDEachParameterApartBaseOptimizer::GetCurrentIteration ( ) const [virtual]

Get the current average step length

virtual const DerivativeType& itk::RSGDEachParameterApartBaseOptimizer::GetCurrentStepLengths ( ) [virtual]

Get the array of all step lengths

virtual const DerivativeType& itk::RSGDEachParameterApartBaseOptimizer::GetGradient ( ) [virtual]

Get the current GradientMagnitude

Definition at line 63 of file itkRSGDEachParameterApartBaseOptimizer.h.

virtual unsigned long itk::RSGDEachParameterApartBaseOptimizer::GetNumberOfIterations ( ) const [virtual]
virtual MeasureType itk::RSGDEachParameterApartBaseOptimizer::GetValue ( ) const [virtual]

Definition at line 69 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 67 of file itkRSGDEachParameterApartBaseOptimizer.h.

Method for creation through the object factory.

Reimplemented in elastix::RSGDEachParameterApart< TElastix >, and itk::RSGDEachParameterApartOptimizer.

void itk::RSGDEachParameterApartBaseOptimizer::operator= ( const Self ) [private]
void itk::RSGDEachParameterApartBaseOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected]

Resume previously stopped optimization with current parameters.

See also:
StopOptimization

Specify whether to minimize or maximize the cost function.

Set/Get parameters to control the optimization process.

Definition at line 65 of file itkRSGDEachParameterApartBaseOptimizer.h.

virtual void itk::RSGDEachParameterApartBaseOptimizer::SetNumberOfIterations ( unsigned long  _arg) [virtual]

Start optimization.

virtual void itk::RSGDEachParameterApartBaseOptimizer::StepAlongGradient ( const DerivativeType &  ,
const DerivativeType &   
) [inline, protected, virtual]

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

In RSGDEachParameterApart this function does not accepts a single scalar steplength factor, but an array of factors, which contains the steplength for each parameter apart.

See also:
AdvanceOneStep

Reimplemented in itk::RSGDEachParameterApartOptimizer.

Definition at line 127 of file itkRSGDEachParameterApartBaseOptimizer.h.

Stop optimization.

See also:
ResumeOptimization

Field Documentation

Definition at line 161 of file itkRSGDEachParameterApartBaseOptimizer.h.

The average current step length

Definition at line 157 of file itkRSGDEachParameterApartBaseOptimizer.h.

All current step lengths

Definition at line 155 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 144 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 163 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 150 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 148 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 151 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 152 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 160 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 145 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 147 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 159 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 149 of file itkRSGDEachParameterApartBaseOptimizer.h.



Generated on 24-05-2012 for elastix by doxygen 1.7.6.1 elastix logo