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>

Detailed Description

An optimizer based on gradient descent...

This optimizer

Definition at line 36 of file itkRSGDEachParameterApartBaseOptimizer.h.

Inheritance diagram for itk::RSGDEachParameterApartBaseOptimizer:
Inheritance 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 &)
 

Member Typedef Documentation

Definition at line 45 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 44 of file itkRSGDEachParameterApartBaseOptimizer.h.

Standard "Self" typedef.

Definition at line 42 of file itkRSGDEachParameterApartBaseOptimizer.h.

Definition at line 43 of file itkRSGDEachParameterApartBaseOptimizer.h.

Member Enumeration Documentation

Codes of stopping conditions.

Enumerator
GradientMagnitudeTolerance 
StepTooSmall 
ImageNotAvailable 
SamplesNotAvailable 
MaximumNumberOfIterations 
MetricError 

Definition at line 55 of file itkRSGDEachParameterApartBaseOptimizer.h.

Constructor & Destructor Documentation

itk::RSGDEachParameterApartBaseOptimizer::RSGDEachParameterApartBaseOptimizer ( )
protected
virtual itk::RSGDEachParameterApartBaseOptimizer::~RSGDEachParameterApartBaseOptimizer ( )
inlineprotectedvirtual

Definition at line 114 of file itkRSGDEachParameterApartBaseOptimizer.h.

itk::RSGDEachParameterApartBaseOptimizer::RSGDEachParameterApartBaseOptimizer ( const Self )
private

Member Function Documentation

virtual void itk::RSGDEachParameterApartBaseOptimizer::AdvanceOneStep ( void  )
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 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
virtual double itk::RSGDEachParameterApartBaseOptimizer::GetCurrentStepLength ( ) 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
virtual double itk::RSGDEachParameterApartBaseOptimizer::GetGradientMagnitude ( ) const
virtual

Get the current GradientMagnitude

virtual double itk::RSGDEachParameterApartBaseOptimizer::GetGradientMagnitudeTolerance ( ) const
virtual
virtual bool itk::RSGDEachParameterApartBaseOptimizer::GetMaximize ( ) const
virtual
virtual double itk::RSGDEachParameterApartBaseOptimizer::GetMaximumStepLength ( ) const
virtual
bool itk::RSGDEachParameterApartBaseOptimizer::GetMinimize ( ) const
inline

Definition at line 68 of file itkRSGDEachParameterApartBaseOptimizer.h.

virtual double itk::RSGDEachParameterApartBaseOptimizer::GetMinimumStepLength ( ) const
virtual
virtual unsigned long itk::RSGDEachParameterApartBaseOptimizer::GetNumberOfIterations ( ) const
virtual
virtual StopConditionType itk::RSGDEachParameterApartBaseOptimizer::GetStopCondition ( ) const
virtual
virtual MeasureType itk::RSGDEachParameterApartBaseOptimizer::GetValue ( ) const
virtual
virtual void itk::RSGDEachParameterApartBaseOptimizer::MaximizeOff ( )
virtual
virtual void itk::RSGDEachParameterApartBaseOptimizer::MaximizeOn ( )
virtual
void itk::RSGDEachParameterApartBaseOptimizer::MinimizeOff ( void  )
inline

Definition at line 74 of file itkRSGDEachParameterApartBaseOptimizer.h.

void itk::RSGDEachParameterApartBaseOptimizer::MinimizeOn ( void  )
inline

Definition at line 72 of file itkRSGDEachParameterApartBaseOptimizer.h.

static Pointer itk::RSGDEachParameterApartBaseOptimizer::New ( )
static

Method for creation through the object factory.

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

Resume previously stopped optimization with current parameters.

See also
StopOptimization
virtual void itk::RSGDEachParameterApartBaseOptimizer::SetGradientMagnitudeTolerance ( double  _arg)
virtual
virtual void itk::RSGDEachParameterApartBaseOptimizer::SetMaximize ( bool  _arg)
virtual

Specify whether to minimize or maximize the cost function.

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

Set/Get parameters to control the optimization process.

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

Definition at line 70 of file itkRSGDEachParameterApartBaseOptimizer.h.

virtual void itk::RSGDEachParameterApartBaseOptimizer::SetMinimumStepLength ( double  _arg)
virtual
virtual void itk::RSGDEachParameterApartBaseOptimizer::SetNumberOfIterations ( unsigned long  _arg)
virtual
void itk::RSGDEachParameterApartBaseOptimizer::StartOptimization ( void  )

Start optimization.

virtual void itk::RSGDEachParameterApartBaseOptimizer::StepAlongGradient ( const DerivativeType &  ,
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

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 132 of file itkRSGDEachParameterApartBaseOptimizer.h.

void itk::RSGDEachParameterApartBaseOptimizer::StopOptimization ( void  )

Stop optimization.

See also
ResumeOptimization

Field Documentation

unsigned long itk::RSGDEachParameterApartBaseOptimizer::m_CurrentIteration
protected

Definition at line 167 of file itkRSGDEachParameterApartBaseOptimizer.h.

double itk::RSGDEachParameterApartBaseOptimizer::m_CurrentStepLength
protected

The average current step length

Definition at line 163 of file itkRSGDEachParameterApartBaseOptimizer.h.

DerivativeType itk::RSGDEachParameterApartBaseOptimizer::m_CurrentStepLengths
protected

All current step lengths

Definition at line 161 of file itkRSGDEachParameterApartBaseOptimizer.h.

DerivativeType itk::RSGDEachParameterApartBaseOptimizer::m_Gradient
protected

Definition at line 150 of file itkRSGDEachParameterApartBaseOptimizer.h.

double itk::RSGDEachParameterApartBaseOptimizer::m_GradientMagnitude
protected

Definition at line 169 of file itkRSGDEachParameterApartBaseOptimizer.h.

double itk::RSGDEachParameterApartBaseOptimizer::m_GradientMagnitudeTolerance
protected

Definition at line 156 of file itkRSGDEachParameterApartBaseOptimizer.h.

bool itk::RSGDEachParameterApartBaseOptimizer::m_Maximize
protected

Definition at line 154 of file itkRSGDEachParameterApartBaseOptimizer.h.

double itk::RSGDEachParameterApartBaseOptimizer::m_MaximumStepLength
protected

Definition at line 157 of file itkRSGDEachParameterApartBaseOptimizer.h.

double itk::RSGDEachParameterApartBaseOptimizer::m_MinimumStepLength
protected

Definition at line 158 of file itkRSGDEachParameterApartBaseOptimizer.h.

unsigned long itk::RSGDEachParameterApartBaseOptimizer::m_NumberOfIterations
protected

Definition at line 166 of file itkRSGDEachParameterApartBaseOptimizer.h.

DerivativeType itk::RSGDEachParameterApartBaseOptimizer::m_PreviousGradient
protected

Definition at line 151 of file itkRSGDEachParameterApartBaseOptimizer.h.

bool itk::RSGDEachParameterApartBaseOptimizer::m_Stop
protected

Definition at line 153 of file itkRSGDEachParameterApartBaseOptimizer.h.

StopConditionType itk::RSGDEachParameterApartBaseOptimizer::m_StopCondition
protected

Definition at line 165 of file itkRSGDEachParameterApartBaseOptimizer.h.

MeasureType itk::RSGDEachParameterApartBaseOptimizer::m_Value
protected

Definition at line 155 of file itkRSGDEachParameterApartBaseOptimizer.h.



Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo