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
elastix::RSGDEachParameterApart< TElastix > Class Template Reference

#include <elxRSGDEachParameterApart.h>

Inheritance diagram for elastix::RSGDEachParameterApart< TElastix >:
Inheritance graph
[legend]
Collaboration diagram for elastix::RSGDEachParameterApart< 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 RSGDEachParameterApart Self
typedef
RSGDEachParameterApartOptimizer 
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 ("RSGDEachParameterApart")
virtual const char * GetClassName () const
virtual void SetInitialPosition (const ParametersType &param)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 RSGDEachParameterApart ()
virtual ~RSGDEachParameterApart ()

Private Member Functions

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

Detailed Description

template<class TElastix>
class elastix::RSGDEachParameterApart< TElastix >

An optimizer based on gradient descent.

The underlying itk class is almost a copy of the normal RegularStepGradientDescent. The difference is that each parameter has its own step length, whereas the normal RSGD has one step length that is used for all parameters.

This could cause inaccuracies, if, for example, parameter 1, 2 and 3 are already close to the optimum, but parameter 4 not yet. The average stepsize is halved then, so parameter 4 will not have time to reach its optimum (in a worst case scenario).

The RSGDEachParameterApart stops only if ALL steplenghts are smaller than the MinimumStepSize given in the parameter file!

The elastix shell class (so, this class...), is a copy of the elxRegularStepGradientDescent, so the parameters in the parameter file, the output etc are similar.

The parameters used in this class are:

Parameters:
Optimizer: Select this optimizer as follows:
(Optimizer "RSGDEachParameterApart")
Parameters:
MaximumNumberOfIterations: the maximum number of iterations in each resolution.
example: (MaximumNumberOfIterations 100 100 50)
Default value: 100.
Parameters:
MinimumGradientMagnitude: stopping criterion. If the magnitude of the derivative of the cost function is below this value, optimisation is stopped.
example: (MinimumGradientMagnitude 0.0001 0.0001 0.001)
Default value: 1e-8.
Parameters:
MinimumStepLength: stopping criterion. If the steplength is below this value, optimisation is stopped.
example: (MinimumStepLength 1.0 0.5 0.1)
Default value: 0.5 / 2^resolutionlevel
Parameters:
MaximumStepLength: the starting steplength.
example: (MaxiumStepLength 16.0 8.0 4.0)
Default value: 16 / 2^resolutionlevel.

Definition at line 70 of file elxRSGDEachParameterApart.h.


Member Typedef Documentation

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 105 of file elxRSGDEachParameterApart.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 104 of file elxRSGDEachParameterApart.h.

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

Reimplemented from itk::RSGDEachParameterApartOptimizer.

Definition at line 83 of file elxRSGDEachParameterApart.h.

Reimplemented from itk::RSGDEachParameterApartOptimizer.

Definition at line 99 of file elxRSGDEachParameterApart.h.

template<class TElastix >
typedef Superclass1::CostFunctionType elastix::RSGDEachParameterApart< TElastix >::CostFunctionType

Typedef's inherited from Superclass1.

Reimplemented from itk::RSGDEachParameterApartOptimizer.

Definition at line 98 of file elxRSGDEachParameterApart.h.

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

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 103 of file elxRSGDEachParameterApart.h.

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

Typedef's inherited from Elastix.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 102 of file elxRSGDEachParameterApart.h.

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

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 108 of file elxRSGDEachParameterApart.h.

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

Typedef for the ParametersType.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 111 of file elxRSGDEachParameterApart.h.

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

Reimplemented from itk::RSGDEachParameterApartOptimizer.

Definition at line 82 of file elxRSGDEachParameterApart.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 107 of file elxRSGDEachParameterApart.h.

template<class TElastix >
typedef Superclass2::RegistrationType elastix::RSGDEachParameterApart< TElastix >::RegistrationType

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 106 of file elxRSGDEachParameterApart.h.

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

Standard ITK.

Reimplemented from itk::RSGDEachParameterApartOptimizer.

Definition at line 79 of file elxRSGDEachParameterApart.h.

template<class TElastix >
typedef RSGDEachParameterApartOptimizer elastix::RSGDEachParameterApart< TElastix >::Superclass1

Definition at line 80 of file elxRSGDEachParameterApart.h.

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

Definition at line 81 of file elxRSGDEachParameterApart.h.


Constructor & Destructor Documentation

template<class TElastix >
elastix::RSGDEachParameterApart< TElastix >::RSGDEachParameterApart ( ) [inline, protected]

Definition at line 128 of file elxRSGDEachParameterApart.h.

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

Definition at line 129 of file elxRSGDEachParameterApart.h.

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

Member Function Documentation

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

Reimplemented from elastix::BaseComponent.

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

Reimplemented from elastix::BaseComponent.

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

Reimplemented from elastix::BaseComponent.

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

Reimplemented from elastix::BaseComponent.

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

Methods that have to be present everywhere.

Reimplemented from elastix::BaseComponent.

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

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

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

Run-time type information (and related methods).

Reimplemented from itk::RSGDEachParameterApartOptimizer.

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

Method for creation through the object factory.

Reimplemented from itk::RSGDEachParameterApartOptimizer.

template<class TElastix >
void elastix::RSGDEachParameterApart< TElastix >::operator= ( const Self ) [private]
template<class TElastix >
virtual void elastix::RSGDEachParameterApart< TElastix >::SetInitialPosition ( const ParametersType param) [virtual]

Override the SetInitialPosition. Override the implementation in itkOptimizer.h, to ensure that the scales array and the parameters array have the same size.



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