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:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
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) override
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 override
	RSGDEachParameterApartBaseOptimizer ()
virtual void	StepAlongGradient (const DerivativeType &, const DerivativeType &)
	~RSGDEachParameterApartBaseOptimizer () override

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

ConstPointer

typedef SmartPointer< const Self > itk::RSGDEachParameterApartBaseOptimizer::ConstPointer

Definition at line 45 of file itkRSGDEachParameterApartBaseOptimizer.h.

Pointer

typedef SmartPointer< Self > itk::RSGDEachParameterApartBaseOptimizer::Pointer

Definition at line 44 of file itkRSGDEachParameterApartBaseOptimizer.h.

Self

typedef RSGDEachParameterApartBaseOptimizer itk::RSGDEachParameterApartBaseOptimizer::Self

Standard "Self" typedef.

Definition at line 42 of file itkRSGDEachParameterApartBaseOptimizer.h.

Superclass

typedef SingleValuedNonLinearOptimizer itk::RSGDEachParameterApartBaseOptimizer::Superclass

Definition at line 43 of file itkRSGDEachParameterApartBaseOptimizer.h.

Member Enumeration Documentation

StopConditionType

enum itk::RSGDEachParameterApartBaseOptimizer::StopConditionType

Codes of stopping conditions.

Enumerator
GradientMagnitudeTolerance
StepTooSmall
ImageNotAvailable
SamplesNotAvailable
MaximumNumberOfIterations
MetricError

Definition at line 55 of file itkRSGDEachParameterApartBaseOptimizer.h.

Constructor & Destructor Documentation

RSGDEachParameterApartBaseOptimizer() [1/2]

itk::RSGDEachParameterApartBaseOptimizer::RSGDEachParameterApartBaseOptimizer ( )

protected

~RSGDEachParameterApartBaseOptimizer()

itk::RSGDEachParameterApartBaseOptimizer::~RSGDEachParameterApartBaseOptimizer ( )

inlineoverrideprotected

Definition at line 114 of file itkRSGDEachParameterApartBaseOptimizer.h.

RSGDEachParameterApartBaseOptimizer() [2/2]

itk::RSGDEachParameterApartBaseOptimizer::RSGDEachParameterApartBaseOptimizer ( const Self &  )

private

Member Function Documentation

AdvanceOneStep()

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.

GetClassName()

virtual const char * itk::RSGDEachParameterApartBaseOptimizer::GetClassName ( ) const

virtual

Run-time type information (and related methods).

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

GetCurrentIteration()

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

virtual

GetCurrentStepLength()

virtual double itk::RSGDEachParameterApartBaseOptimizer::GetCurrentStepLength ( ) const

virtual

Get the current average step length

GetCurrentStepLengths()

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

virtual

Get the array of all step lengths

GetGradient()

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

virtual

GetGradientMagnitude()

virtual double itk::RSGDEachParameterApartBaseOptimizer::GetGradientMagnitude ( ) const

virtual

Get the current GradientMagnitude

GetGradientMagnitudeTolerance()

virtual double itk::RSGDEachParameterApartBaseOptimizer::GetGradientMagnitudeTolerance ( ) const

virtual

GetMaximize()

virtual bool itk::RSGDEachParameterApartBaseOptimizer::GetMaximize ( ) const

virtual

GetMaximumStepLength()

virtual double itk::RSGDEachParameterApartBaseOptimizer::GetMaximumStepLength ( ) const

virtual

GetMinimize()

bool itk::RSGDEachParameterApartBaseOptimizer::GetMinimize ( ) const

inline

Definition at line 68 of file itkRSGDEachParameterApartBaseOptimizer.h.

GetMinimumStepLength()

virtual double itk::RSGDEachParameterApartBaseOptimizer::GetMinimumStepLength ( ) const

virtual

GetNumberOfIterations()

virtual unsigned long itk::RSGDEachParameterApartBaseOptimizer::GetNumberOfIterations ( ) const

virtual

GetStopCondition()

virtual StopConditionType itk::RSGDEachParameterApartBaseOptimizer::GetStopCondition ( ) const

virtual

GetValue()

virtual MeasureType itk::RSGDEachParameterApartBaseOptimizer::GetValue ( ) const

virtual

MaximizeOff()

virtual void itk::RSGDEachParameterApartBaseOptimizer::MaximizeOff ( )

virtual

MaximizeOn()

virtual void itk::RSGDEachParameterApartBaseOptimizer::MaximizeOn ( )

virtual

MinimizeOff()

void itk::RSGDEachParameterApartBaseOptimizer::MinimizeOff ( void  )

inline

Definition at line 74 of file itkRSGDEachParameterApartBaseOptimizer.h.

MinimizeOn()

void itk::RSGDEachParameterApartBaseOptimizer::MinimizeOn ( void  )

inline

Definition at line 72 of file itkRSGDEachParameterApartBaseOptimizer.h.

New()

static Pointer itk::RSGDEachParameterApartBaseOptimizer::New ( )

static

Method for creation through the object factory.

operator=()

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

private

PrintSelf()

void itk::RSGDEachParameterApartBaseOptimizer::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotected

ResumeOptimization()

void itk::RSGDEachParameterApartBaseOptimizer::ResumeOptimization

(

void

)

Resume previously stopped optimization with current parameters.

See also

StopOptimization

SetGradientMagnitudeTolerance()

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

virtual

SetMaximize()

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

virtual

Specify whether to minimize or maximize the cost function.

SetMaximumStepLength()

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

virtual

Set/Get parameters to control the optimization process.

SetMinimize()

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

inline

Definition at line 70 of file itkRSGDEachParameterApartBaseOptimizer.h.

SetMinimumStepLength()

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

virtual

SetNumberOfIterations()

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

virtual

StartOptimization()

void itk::RSGDEachParameterApartBaseOptimizer::StartOptimization ( void  )

override

Start optimization.

StepAlongGradient()

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.

StopOptimization()

void itk::RSGDEachParameterApartBaseOptimizer::StopOptimization

(

void

)

Stop optimization.

See also

ResumeOptimization

Field Documentation

m_CurrentIteration

unsigned long itk::RSGDEachParameterApartBaseOptimizer::m_CurrentIteration

protected

Definition at line 167 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_CurrentStepLength

double itk::RSGDEachParameterApartBaseOptimizer::m_CurrentStepLength

protected

The average current step length

Definition at line 163 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_CurrentStepLengths

DerivativeType itk::RSGDEachParameterApartBaseOptimizer::m_CurrentStepLengths

protected

All current step lengths

Definition at line 161 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_Gradient

DerivativeType itk::RSGDEachParameterApartBaseOptimizer::m_Gradient

protected

Definition at line 150 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_GradientMagnitude

double itk::RSGDEachParameterApartBaseOptimizer::m_GradientMagnitude

protected

Definition at line 169 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_GradientMagnitudeTolerance

double itk::RSGDEachParameterApartBaseOptimizer::m_GradientMagnitudeTolerance

protected

Definition at line 156 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_Maximize

bool itk::RSGDEachParameterApartBaseOptimizer::m_Maximize

protected

Definition at line 154 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_MaximumStepLength

double itk::RSGDEachParameterApartBaseOptimizer::m_MaximumStepLength

protected

Definition at line 157 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_MinimumStepLength

double itk::RSGDEachParameterApartBaseOptimizer::m_MinimumStepLength

protected

Definition at line 158 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_NumberOfIterations

unsigned long itk::RSGDEachParameterApartBaseOptimizer::m_NumberOfIterations

protected

Definition at line 166 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_PreviousGradient

DerivativeType itk::RSGDEachParameterApartBaseOptimizer::m_PreviousGradient

protected

Definition at line 151 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_Stop

bool itk::RSGDEachParameterApartBaseOptimizer::m_Stop

protected

Definition at line 153 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_StopCondition

StopConditionType itk::RSGDEachParameterApartBaseOptimizer::m_StopCondition

protected

Definition at line 165 of file itkRSGDEachParameterApartBaseOptimizer.h.

m_Value

MeasureType itk::RSGDEachParameterApartBaseOptimizer::m_Value

protected

Definition at line 155 of file itkRSGDEachParameterApartBaseOptimizer.h.