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::SimultaneousPerturbation< TElastix > Class Template Reference
Components » Optimizers

#include <elxSimultaneousPerturbation.h>

Detailed Description

template<class TElastix>
class elastix::SimultaneousPerturbation< TElastix >

An optimizer based on the itk::SPSAOptimizer.

The ITK doxygen help gives more information about this optimizer.

This optimizer supports the NewSamplesEveryIteration parameter.

The parameters used in this class are:

Parameters:

Optimizer: Select this optimizer as follows:
(Optimizer "SimultaneousPerturbation")

MaximumNumberOfIterations: The maximum number of iterations in each resolution.
example: (MaximumNumberOfIterations 100 100 50)
Default value: 500.

NumberOfPerturbations: The number of perturbation used to construct a gradient estimate $g_k$.
$q =$ NumberOfPerturbations
$g_k = 1/q \sum_{j = 1..q} g^(j)_k$
This parameter can be defined for each resolution.
example: (NumberOfPerturbations 1 1 2)
Default value: 1.

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.

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.

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.

SP_c: The perturbation step size $c(k)$ at each iteration $k$ is defined by
$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.

SP_gamma: The perturbation step size $c(k)$ at each iteration $k$ is defined by
$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.

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.

Definition at line 83 of file elxSimultaneousPerturbation.h.

+ Inheritance diagram for elastix::SimultaneousPerturbation< TElastix >:

Public Types

typedef Superclass2::ConfigurationPointer ConfigurationPointer
 
typedef Superclass2::ConfigurationType ConfigurationType
 
typedef itk::SmartPointer< const Self > ConstPointer
 
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 itk::SmartPointer< Self > Pointer
 
typedef Superclass2::RegistrationPointer RegistrationPointer
 
typedef Superclass2::RegistrationType RegistrationType
 
typedef SimultaneousPerturbation Self
 
typedef Superclass1::StopConditionType StopConditionType
 
typedef SPSAOptimizer Superclass1
 
typedef OptimizerBase< TElastix > Superclass2
 
- Public Types inherited from elastix::OptimizerBase< TElastix >
typedef Superclass::ConfigurationPointer ConfigurationPointer
 
typedef Superclass::ConfigurationType ConfigurationType
 
typedef Superclass::ElastixPointer ElastixPointer
 
typedef Superclass::ElastixType ElastixType
 
typedef itk::Optimizer ITKBaseType
 
typedef ITKBaseType::ParametersType ParametersType
 
typedef Superclass::RegistrationPointer RegistrationPointer
 
typedef Superclass::RegistrationType RegistrationType
 
typedef OptimizerBase Self
 
typedef BaseComponentSE< TElastix > Superclass
 
- Public Types inherited from elastix::BaseComponentSE< TElastix >
typedef ElastixType::ConfigurationPointer ConfigurationPointer
 
typedef ElastixType::ConfigurationType ConfigurationType
 
typedef itk::WeakPointer< ElastixType > ElastixPointer
 
typedef TElastix ElastixType
 
typedef RegistrationType * RegistrationPointer
 
typedef ElastixType::RegistrationBaseType RegistrationType
 
typedef BaseComponentSE Self
 
typedef BaseComponent Superclass
 

Public Member Functions

virtual void AfterEachIteration (void)
 
virtual void AfterEachResolution (void)
 
virtual void AfterRegistration (void)
 
virtual void BeforeEachResolution (void)
 
virtual void BeforeRegistration (void)
 
 elxClassNameMacro ("SimultaneousPerturbation")
 
virtual const char * GetClassName () const
 
virtual void SetInitialPosition (const ParametersType &param)
 
- Public Member Functions inherited from elastix::OptimizerBase< TElastix >
virtual void AfterRegistrationBase (void) ITK_OVERRIDE
 
virtual void BeforeEachResolutionBase () ITK_OVERRIDE
 
virtual ITKBaseType * GetAsITKBaseType (void)
 
virtual const ITKBaseType * GetAsITKBaseType (void) const
 
virtual void SetCurrentPositionPublic (const ParametersType &param)
 
virtual void SetSinusScales (double amplitude, double frequency, unsigned long numberOfParameters)
 
- Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
virtual ConfigurationType * GetConfiguration (void) const
 
virtual ElastixType * GetElastix (void) const
 
virtual RegistrationPointer GetRegistration (void) const
 
virtual void SetConfiguration (ConfigurationType *_arg)
 
virtual void SetElastix (ElastixType *_arg)
 
- Public Member Functions inherited from elastix::BaseComponent
virtual void AfterEachIterationBase (void)
 
virtual void AfterEachResolutionBase (void)
 
virtual int BeforeAll (void)
 
virtual int BeforeAllBase (void)
 
virtual void BeforeRegistrationBase (void)
 
std::string ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision) const
 
virtual const char * elxGetClassName (void) const
 
virtual const char * GetComponentLabel (void) const
 
 itkTypeMacroNoParent (BaseComponent)
 
virtual void SetComponentLabel (const char *label, unsigned int idx)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 SimultaneousPerturbation ()
 
virtual ~SimultaneousPerturbation ()
 
- Protected Member Functions inherited from elastix::OptimizerBase< TElastix >
virtual bool GetNewSamplesEveryIteration (void) const
 
 OptimizerBase ()
 
virtual void SelectNewSamples (void)
 
virtual ~OptimizerBase ()
 
- Protected Member Functions inherited from elastix::BaseComponentSE< TElastix >
 BaseComponentSE ()
 
virtual ~BaseComponentSE ()
 
- Protected Member Functions inherited from elastix::BaseComponent
 BaseComponent ()
 
virtual ~BaseComponent ()
 

Protected Attributes

bool m_ShowMetricValues
 
- Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer m_Configuration
 
ElastixPointer m_Elastix
 
RegistrationPointer m_Registration
 

Private Member Functions

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

Member Typedef Documentation

◆ ConfigurationPointer

template<class TElastix >
typedef Superclass2::ConfigurationPointer elastix::SimultaneousPerturbation< TElastix >::ConfigurationPointer

Definition at line 119 of file elxSimultaneousPerturbation.h.

◆ ConfigurationType

template<class TElastix >
typedef Superclass2::ConfigurationType elastix::SimultaneousPerturbation< TElastix >::ConfigurationType

Definition at line 118 of file elxSimultaneousPerturbation.h.

◆ ConstPointer

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

Definition at line 96 of file elxSimultaneousPerturbation.h.

◆ CostFunctionPointer

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

Definition at line 112 of file elxSimultaneousPerturbation.h.

◆ CostFunctionType

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

Typedef's inherited from Superclass1.

Definition at line 111 of file elxSimultaneousPerturbation.h.

◆ ElastixPointer

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

Definition at line 117 of file elxSimultaneousPerturbation.h.

◆ ElastixType

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

Typedef's inherited from Elastix.

Definition at line 116 of file elxSimultaneousPerturbation.h.

◆ ITKBaseType

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

Definition at line 122 of file elxSimultaneousPerturbation.h.

◆ ParametersType

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

Typedef for the ParametersType.

Definition at line 125 of file elxSimultaneousPerturbation.h.

◆ Pointer

template<class TElastix >
typedef itk::SmartPointer< Self > elastix::SimultaneousPerturbation< TElastix >::Pointer

Definition at line 95 of file elxSimultaneousPerturbation.h.

◆ RegistrationPointer

template<class TElastix >
typedef Superclass2::RegistrationPointer elastix::SimultaneousPerturbation< TElastix >::RegistrationPointer

Definition at line 121 of file elxSimultaneousPerturbation.h.

◆ RegistrationType

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

Definition at line 120 of file elxSimultaneousPerturbation.h.

◆ Self

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

Standard ITK.

Definition at line 92 of file elxSimultaneousPerturbation.h.

◆ StopConditionType

template<class TElastix >
typedef Superclass1::StopConditionType elastix::SimultaneousPerturbation< TElastix >::StopConditionType

Definition at line 113 of file elxSimultaneousPerturbation.h.

◆ Superclass1

template<class TElastix >
typedef SPSAOptimizer elastix::SimultaneousPerturbation< TElastix >::Superclass1

Definition at line 93 of file elxSimultaneousPerturbation.h.

◆ Superclass2

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

Definition at line 94 of file elxSimultaneousPerturbation.h.

Constructor & Destructor Documentation

◆ SimultaneousPerturbation() [1/2]

template<class TElastix >
elastix::SimultaneousPerturbation< TElastix >::SimultaneousPerturbation ( )
protected

◆ ~SimultaneousPerturbation()

template<class TElastix >
virtual elastix::SimultaneousPerturbation< TElastix >::~SimultaneousPerturbation ( )
inlineprotectedvirtual

Definition at line 147 of file elxSimultaneousPerturbation.h.

◆ SimultaneousPerturbation() [2/2]

template<class TElastix >
elastix::SimultaneousPerturbation< TElastix >::SimultaneousPerturbation ( const Self &  )
private

Member Function Documentation

◆ AfterEachIteration()

template<class TElastix >
virtual void elastix::SimultaneousPerturbation< TElastix >::AfterEachIteration ( void  )
virtual

Reimplemented from elastix::BaseComponent.

◆ AfterEachResolution()

template<class TElastix >
virtual void elastix::SimultaneousPerturbation< TElastix >::AfterEachResolution ( void  )
virtual

Reimplemented from elastix::BaseComponent.

◆ AfterRegistration()

template<class TElastix >
virtual void elastix::SimultaneousPerturbation< TElastix >::AfterRegistration ( void  )
virtual

Reimplemented from elastix::BaseComponent.

◆ BeforeEachResolution()

template<class TElastix >
virtual void elastix::SimultaneousPerturbation< TElastix >::BeforeEachResolution ( void  )
virtual

Reimplemented from elastix::BaseComponent.

◆ BeforeRegistration()

template<class TElastix >
virtual void elastix::SimultaneousPerturbation< TElastix >::BeforeRegistration ( void  )
virtual

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

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

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

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

◆ GetClassName()

template<class TElastix >
virtual const char* elastix::SimultaneousPerturbation< TElastix >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from elastix::OptimizerBase< TElastix >.

◆ New()

template<class TElastix >
static Pointer elastix::SimultaneousPerturbation< TElastix >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TElastix >
void elastix::SimultaneousPerturbation< TElastix >::operator= ( const Self &  )
private

◆ SetInitialPosition()

template<class TElastix >
virtual void elastix::SimultaneousPerturbation< 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.

Field Documentation

◆ m_ShowMetricValues

template<class TElastix >
bool elastix::SimultaneousPerturbation< TElastix >::m_ShowMetricValues
protected

Definition at line 149 of file elxSimultaneousPerturbation.h.


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.13 elastix logo