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

#include <elxFiniteDifferenceGradientDescent.h>

Inheritance diagram for elastix::FiniteDifferenceGradientDescent< TElastix >:
Inheritance graph
[legend]
Collaboration diagram for elastix::FiniteDifferenceGradientDescent< 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
FiniteDifferenceGradientDescent 
Self
typedef
Superclass1::StopConditionType 
StopConditionType
typedef
FiniteDifferenceGradientDescentOptimizer 
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 ("FiniteDifferenceGradientDescent")
virtual const char * GetClassName () const
virtual void StartOptimization (void)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 FiniteDifferenceGradientDescent ()
virtual ~FiniteDifferenceGradientDescent ()

Protected Attributes

bool m_ShowMetricValues

Private Member Functions

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

Detailed Description

template<class TElastix>
class elastix::FiniteDifferenceGradientDescent< TElastix >

An optimizer based on the itk::FiniteDifferenceGradientDescentOptimizer.

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

Watch out for this optimizer; it may be very slow....

The parameters used in this class are:

Parameters:
Optimizer: Select this optimizer as follows:
(Optimizer "FiniteDifferenceGradientDescent")
Parameters:
MaximumNumberOfIterations: The maximum number of iterations in each resolution.
example: (MaximumNumberOfIterations 100 100 50)
Default value: 500.
Parameters:
SP_a: The gain $a(k)$ at each iteration $k$ is defined by
$\quad 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
$\quad 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
$\quad 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.
Parameters:
SP_c: The perturbation step size $c(k)$ at each iteration $k$ is defined by
$\quad c(k) = SP\_c / ( k + 1)^{SP\_gamma}$.
SP_c can be defined for each resolution.
example: (SP_c 2.0 1.0 1.0)
The default value is 1.0.
Parameters:
SP_gamma: The perturbation step size $c(k)$ at each iteration $k$ is defined by
$\quad c(k) = SP\_c / ( k + 1)^{SP\_gamma}$.
SP_gamma can be defined for each resolution.
example: (SP_gamma 0.101 0.101 0.101)
The default/recommended value is 0.101.
Parameters:
ShowMetricValues: Defines whether to compute/show the metric value in each iteration.
This flag can NOT be defined for each resolution.
example: (ShowMetricValues "true" )
Default value: "false". Note that turning this flag on increases computation time.
See also:
FiniteDifferenceGradientDescentOptimizer

Definition at line 78 of file elxFiniteDifferenceGradientDescent.h.


Member Typedef Documentation

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 114 of file elxFiniteDifferenceGradientDescent.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 113 of file elxFiniteDifferenceGradientDescent.h.

template<class TElastix >
typedef SmartPointer<const Self> elastix::FiniteDifferenceGradientDescent< TElastix >::ConstPointer
template<class TElastix >
typedef Superclass1::CostFunctionPointer elastix::FiniteDifferenceGradientDescent< TElastix >::CostFunctionPointer

Definition at line 107 of file elxFiniteDifferenceGradientDescent.h.

Typedef's inherited from Superclass1.

Reimplemented from itk::ScaledSingleValuedNonLinearOptimizer.

Definition at line 106 of file elxFiniteDifferenceGradientDescent.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 112 of file elxFiniteDifferenceGradientDescent.h.

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

Typedef's inherited from Elastix.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 111 of file elxFiniteDifferenceGradientDescent.h.

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

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 117 of file elxFiniteDifferenceGradientDescent.h.

Typedef for the ParametersType.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 120 of file elxFiniteDifferenceGradientDescent.h.

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

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 116 of file elxFiniteDifferenceGradientDescent.h.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 115 of file elxFiniteDifferenceGradientDescent.h.

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

Standard ITK.

Reimplemented from itk::FiniteDifferenceGradientDescentOptimizer.

Definition at line 87 of file elxFiniteDifferenceGradientDescent.h.

Definition at line 88 of file elxFiniteDifferenceGradientDescent.h.

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

Definition at line 89 of file elxFiniteDifferenceGradientDescent.h.


Constructor & Destructor Documentation

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

Definition at line 136 of file elxFiniteDifferenceGradientDescent.h.

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

Member Function Documentation

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

Reimplemented from elastix::BaseComponent.

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

Reimplemented from elastix::BaseComponent.

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

Reimplemented from elastix::BaseComponent.

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

Reimplemented from elastix::BaseComponent.

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

Methods that take care of setting parameters and printing progress information.

Reimplemented from elastix::BaseComponent.

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

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

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

Run-time type information (and related methods).

Reimplemented from itk::FiniteDifferenceGradientDescentOptimizer.

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

Method for creation through the object factory.

Reimplemented from itk::FiniteDifferenceGradientDescentOptimizer.

template<class TElastix >
void elastix::FiniteDifferenceGradientDescent< TElastix >::operator= ( const Self ) [private]
template<class TElastix >
virtual void elastix::FiniteDifferenceGradientDescent< 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::FiniteDifferenceGradientDescentOptimizer.


Field Documentation

template<class TElastix >
bool elastix::FiniteDifferenceGradientDescent< TElastix >::m_ShowMetricValues [protected]

Definition at line 136 of file elxFiniteDifferenceGradientDescent.h.



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