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 | Private Member Functions | Private Attributes
elastix::StandardGradientDescent< TElastix > Class Template Reference

#include <elxStandardGradientDescent.h>

Inheritance diagram for elastix::StandardGradientDescent< TElastix >:
Inheritance graph
[legend]
Collaboration diagram for elastix::StandardGradientDescent< TElastix >:
Collaboration graph
[legend]

Public Types

typedef
Superclass2::ConfigurationPointer 
ConfigurationPointer
typedef
Superclass2::ConfigurationType 
ConfigurationType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass1::CostFunctionPointer 
CostFunctionPointer
typedef
Superclass1::CostFunctionType 
CostFunctionType
typedef Superclass2::ElastixPointer ElastixPointer
typedef Superclass2::ElastixType ElastixType
typedef Superclass2::ITKBaseType ITKBaseType
typedef Superclass1::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef
Superclass2::RegistrationPointer 
RegistrationPointer
typedef
Superclass2::RegistrationType 
RegistrationType
typedef StandardGradientDescent Self
typedef
Superclass1::StopConditionType 
StopConditionType
typedef
StandardGradientDescentOptimizer 
Superclass1
typedef OptimizerBase< TElastix > Superclass2

Public Member Functions

virtual void AfterEachIteration (void)
virtual void AfterEachResolution (void)
virtual void AfterRegistration (void)
virtual void BeforeEachResolution (void)
virtual void BeforeRegistration (void)
 elxClassNameMacro ("StandardGradientDescent")
virtual const char * GetClassName () const
virtual const unsigned long & GetMaximumNumberOfSamplingAttempts ()
virtual void MetricErrorResponse (ExceptionObject &err)
virtual void SetCurrentPositionPublic (const ParametersType &param)
virtual void SetMaximumNumberOfSamplingAttempts (unsigned long _arg)
virtual void StartOptimization (void)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 StandardGradientDescent ()
virtual ~StandardGradientDescent ()

Private Member Functions

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

Private Attributes

unsigned long m_CurrentNumberOfSamplingAttempts
unsigned long m_MaximumNumberOfSamplingAttempts
unsigned long m_PreviousErrorAtIteration

Detailed Description

template<class TElastix>
class elastix::StandardGradientDescent< TElastix >

A gradient descent optimizer with a decaying gain.

This class is a wrap around the StandardGradientDescentOptimizer class. It takes care of setting parameters and printing progress information. For more information about the optimisation method, please read the documentation of the StandardGradientDescentOptimizer class.

The parameters used in this class are:

Parameters:
Optimizer: Select this optimizer as follows:
(Optimizer "StandardGradientDescent")
Parameters:
MaximumNumberOfIterations: The maximum number of iterations in each resolution.
example: (MaximumNumberOfIterations 100 100 50)
Default/recommended value: 500.
Parameters:
MaximumNumberOfSamplingAttempts: The maximum number of sampling attempts. Sometimes not enough corresponding samples can be drawn, upon which an exception is thrown. With this parameter it is possible to try to draw another set of samples.
example: (MaximumNumberOfSamplingAttempts 10 15 10)
Default value: 0, i.e. just fail immediately, for backward compatibility.
Parameters:
SP_a: The gain $a(k)$ at each iteration $k$ is defined by
$a(k) = SP\_a / (SP\_A + k + 1)^{SP\_alpha}$.
SP_a can be defined for each resolution.
example: (SP_a 3200.0 3200.0 1600.0)
The default value is 400.0. Tuning this variable for you specific problem is recommended.
Parameters:
SP_A: The gain $a(k)$ at each iteration $k$ is defined by
$a(k) = SP\_a / (SP\_A + k + 1)^{SP\_alpha}$.
SP_A can be defined for each resolution.
example: (SP_A 50.0 50.0 100.0)
The default/recommended value is 50.0.
Parameters:
SP_alpha: The gain $a(k)$ at each iteration $k$ is defined by
$a(k) = SP\_a / (SP\_A + k + 1)^{SP\_alpha}$.
SP_alpha can be defined for each resolution.
example: (SP_alpha 0.602 0.602 0.602)
The default/recommended value is 0.602.
See also:
StandardGradientDescentOptimizer

Definition at line 67 of file elxStandardGradientDescent.h.


Member Typedef Documentation

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 103 of file elxStandardGradientDescent.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 102 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef SmartPointer<const Self> elastix::StandardGradientDescent< TElastix >::ConstPointer

Reimplemented from itk::StandardGradientDescentOptimizer.

Definition at line 80 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef Superclass1::CostFunctionPointer elastix::StandardGradientDescent< TElastix >::CostFunctionPointer

Definition at line 96 of file elxStandardGradientDescent.h.

Typedef's inherited from Superclass1, the StandardGradientDescentOptimizer.

Reimplemented from itk::StandardGradientDescentOptimizer.

Definition at line 95 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef Superclass2::ElastixPointer elastix::StandardGradientDescent< TElastix >::ElastixPointer

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 101 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef Superclass2::ElastixType elastix::StandardGradientDescent< TElastix >::ElastixType

Typedef's inherited from Superclass2, the elastix OptimizerBase .

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 100 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef Superclass2::ITKBaseType elastix::StandardGradientDescent< TElastix >::ITKBaseType

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 106 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef Superclass1::ParametersType elastix::StandardGradientDescent< TElastix >::ParametersType

Typedef for the ParametersType.

Reimplemented from itk::StandardGradientDescentOptimizer.

Definition at line 109 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef SmartPointer<Self> elastix::StandardGradientDescent< TElastix >::Pointer

Reimplemented from itk::StandardGradientDescentOptimizer.

Definition at line 79 of file elxStandardGradientDescent.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 105 of file elxStandardGradientDescent.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 104 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef StandardGradientDescent elastix::StandardGradientDescent< TElastix >::Self

Standard ITK.

Reimplemented from itk::StandardGradientDescentOptimizer.

Definition at line 76 of file elxStandardGradientDescent.h.

Reimplemented from itk::StandardGradientDescentOptimizer.

Definition at line 97 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef StandardGradientDescentOptimizer elastix::StandardGradientDescent< TElastix >::Superclass1

Definition at line 77 of file elxStandardGradientDescent.h.

template<class TElastix >
typedef OptimizerBase<TElastix> elastix::StandardGradientDescent< TElastix >::Superclass2

Definition at line 78 of file elxStandardGradientDescent.h.


Constructor & Destructor Documentation

template<class TElastix >
elastix::StandardGradientDescent< TElastix >::StandardGradientDescent ( ) [protected]
template<class TElastix >
virtual elastix::StandardGradientDescent< TElastix >::~StandardGradientDescent ( ) [inline, protected, virtual]

Definition at line 143 of file elxStandardGradientDescent.h.

template<class TElastix >
elastix::StandardGradientDescent< TElastix >::StandardGradientDescent ( const Self ) [private]

Member Function Documentation

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::AfterEachIteration ( void  ) [virtual]

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::AfterEachResolution ( void  ) [virtual]

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::AfterRegistration ( void  ) [virtual]

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::BeforeEachResolution ( void  ) [virtual]

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::BeforeRegistration ( void  ) [virtual]

Methods invoked by elastix, in which parameters can be set and progress information can be printed.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
elastix::StandardGradientDescent< TElastix >::elxClassNameMacro ( "StandardGradientDescent< TElastix >"  )

Name of this class. Use this name in the parameter file to select this specific optimizer. example: (Optimizer "StandardGradientDescent")

template<class TElastix >
virtual const char* elastix::StandardGradientDescent< TElastix >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::StandardGradientDescentOptimizer.

template<class TElastix >
virtual const unsigned long& elastix::StandardGradientDescent< TElastix >::GetMaximumNumberOfSamplingAttempts ( ) [virtual]

Get the MaximumNumberOfSamplingAttempts.

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::MetricErrorResponse ( ExceptionObject &  err) [virtual]

Stop optimisation and pass on exception.

Reimplemented from itk::GradientDescentOptimizer2.

template<class TElastix >
static Pointer elastix::StandardGradientDescent< TElastix >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::StandardGradientDescentOptimizer.

template<class TElastix >
void elastix::StandardGradientDescent< TElastix >::operator= ( const Self ) [private]
template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::SetCurrentPositionPublic ( const ParametersType param) [inline, virtual]

Add SetCurrentPositionPublic, which calls the protected SetCurrentPosition of the itkStandardGradientDescentOptimizer class.

Definition at line 129 of file elxStandardGradientDescent.h.

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::SetMaximumNumberOfSamplingAttempts ( unsigned long  _arg) [virtual]

Set the MaximumNumberOfSamplingAttempts.

template<class TElastix >
virtual void elastix::StandardGradientDescent< TElastix >::StartOptimization ( void  ) [virtual]

Check if any scales are set, and set the UseScales flag on or off; after that call the superclass' implementation

Reimplemented from itk::StandardGradientDescentOptimizer.


Field Documentation

template<class TElastix >
unsigned long elastix::StandardGradientDescent< TElastix >::m_CurrentNumberOfSamplingAttempts [private]

Definition at line 153 of file elxStandardGradientDescent.h.

template<class TElastix >
unsigned long elastix::StandardGradientDescent< TElastix >::m_MaximumNumberOfSamplingAttempts [private]

Private variables for the sampling attempts.

Definition at line 152 of file elxStandardGradientDescent.h.

template<class TElastix >
unsigned long elastix::StandardGradientDescent< TElastix >::m_PreviousErrorAtIteration [private]

Definition at line 154 of file elxStandardGradientDescent.h.



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