elastix::RegularStepGradientDescent< TElastix > Class Template Reference

#include <elxRegularStepGradientDescent.h>

Detailed Description

template<class TElastix>
class elastix::RegularStepGradientDescent< TElastix >

An optimizer based on gradient descent...

This optimizer is a wrap around the itk::RegularStepGradientDescentOptimizer. This wrap-around class takes care of setting parameters, and printing progress information. For detailed information about the optimisation method, please read the documentation of the itkRegularStepGradientDescentOptimizer (in the ITK-manual).

The parameters used in this class are:

Parameters:

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

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

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.

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

MaximumStepLength: the starting steplength.
example: (MaximumStepLength 16.0 8.0 4.0)
Default value: 16 / 2^resolutionlevel.

RelaxationFactor: the factor with which the steplength is multiplied, if the optimiser notices that a smaller steplength is needed.
example: (RelaxationFactor 0.5 0.5 0.8 ).
Default/recommended value: 0.5.

See also

ImprovedRegularStepGradientDescentOptimizer

Definition at line 65 of file elxRegularStepGradientDescent.h.

Inheritance diagram for elastix::RegularStepGradientDescent< 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 RegularStepGradientDescent	Self
typedef RegularStepGradientDescentOptimizer	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 Configuration::Pointer	ConfigurationPointer
typedef Configuration	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
void	AfterEachIteration (void) override
void	AfterEachResolution (void) override
void	AfterRegistration (void) override
void	BeforeEachResolution (void) override
void	BeforeRegistration (void) override
	elxClassNameMacro ("RegularStepGradientDescent")
virtual const char *	GetClassName () const
void	SetInitialPosition (const ParametersType &param) override
Public Member Functions inherited from elastix::OptimizerBase< TElastix >
void	AfterRegistrationBase (void) override
void	BeforeEachResolutionBase () override
virtual ITKBaseType *	GetAsITKBaseType (void)
virtual const ITKBaseType *	GetAsITKBaseType (void) const
virtual const char *	GetClassName () 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 >
ConfigurationType *	GetConfiguration (void) const
ElastixType *	GetElastix (void) const
RegistrationPointer	GetRegistration (void) const
	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponentSE)
void	SetConfiguration (ConfigurationType *_arg)
void	SetElastix (ElastixType *_arg)
Public Member Functions inherited from elastix::BaseComponent
virtual void	AfterEachIteration (void)
virtual void	AfterEachIterationBase (void)
virtual void	AfterEachResolution (void)
virtual void	AfterEachResolutionBase (void)
virtual void	AfterRegistration (void)
virtual void	AfterRegistrationBase (void)
virtual int	BeforeAll (void)
virtual int	BeforeAllBase (void)
virtual void	BeforeEachResolution (void)
virtual void	BeforeEachResolutionBase (void)
virtual void	BeforeRegistration (void)
virtual void	BeforeRegistrationBase (void)
virtual const char *	elxGetClassName (void) const
const char *	GetComponentLabel (void) const
	ITK_DISALLOW_COPY_AND_ASSIGN (BaseComponent)
	itkTypeMacroNoParent (BaseComponent)
void	SetComponentLabel (const char *label, unsigned int idx)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from elastix::BaseComponent
static std::string	ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision)
static void	InitializeElastixExecutable ()
static bool	IsElastixLibrary ()

Protected Member Functions
	RegularStepGradientDescent ()
	~RegularStepGradientDescent () override
Protected Member Functions inherited from elastix::OptimizerBase< TElastix >
virtual bool	GetNewSamplesEveryIteration (void) const
	OptimizerBase ()
virtual void	SelectNewSamples (void)
	~OptimizerBase () override
Protected Member Functions inherited from elastix::BaseComponentSE< TElastix >
	BaseComponentSE ()=default
	~BaseComponentSE () override=default
Protected Member Functions inherited from elastix::BaseComponent
	BaseComponent ()=default
virtual	~BaseComponent ()=default

Private Member Functions
void	operator= (const Self &)
	RegularStepGradientDescent (const Self &)

Additional Inherited Members
Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer	m_Configuration {}
ElastixPointer	m_Elastix {}
RegistrationPointer	m_Registration {}

Member Typedef Documentation

ConfigurationPointer

template<class TElastix >

typedef Superclass2::ConfigurationPointer elastix::RegularStepGradientDescent< TElastix >::ConfigurationPointer

Definition at line 100 of file elxRegularStepGradientDescent.h.

ConfigurationType

template<class TElastix >

typedef Superclass2::ConfigurationType elastix::RegularStepGradientDescent< TElastix >::ConfigurationType

Definition at line 99 of file elxRegularStepGradientDescent.h.

ConstPointer

template<class TElastix >

typedef itk::SmartPointer< const Self > elastix::RegularStepGradientDescent< TElastix >::ConstPointer

Definition at line 78 of file elxRegularStepGradientDescent.h.

CostFunctionPointer

template<class TElastix >

typedef Superclass1::CostFunctionPointer elastix::RegularStepGradientDescent< TElastix >::CostFunctionPointer

Definition at line 94 of file elxRegularStepGradientDescent.h.

CostFunctionType

template<class TElastix >

typedef Superclass1::CostFunctionType elastix::RegularStepGradientDescent< TElastix >::CostFunctionType

Typedef's inherited from Superclass1.

Definition at line 93 of file elxRegularStepGradientDescent.h.

ElastixPointer

template<class TElastix >

typedef Superclass2::ElastixPointer elastix::RegularStepGradientDescent< TElastix >::ElastixPointer

Definition at line 98 of file elxRegularStepGradientDescent.h.

ElastixType

template<class TElastix >

typedef Superclass2::ElastixType elastix::RegularStepGradientDescent< TElastix >::ElastixType

Typedef's inherited from Elastix.

Definition at line 97 of file elxRegularStepGradientDescent.h.

ITKBaseType

template<class TElastix >

typedef Superclass2::ITKBaseType elastix::RegularStepGradientDescent< TElastix >::ITKBaseType

Definition at line 103 of file elxRegularStepGradientDescent.h.

ParametersType

template<class TElastix >

typedef Superclass1::ParametersType elastix::RegularStepGradientDescent< TElastix >::ParametersType

Typedef for the ParametersType.

Definition at line 106 of file elxRegularStepGradientDescent.h.

Pointer

template<class TElastix >

typedef itk::SmartPointer< Self > elastix::RegularStepGradientDescent< TElastix >::Pointer

Definition at line 77 of file elxRegularStepGradientDescent.h.

RegistrationPointer

template<class TElastix >

typedef Superclass2::RegistrationPointer elastix::RegularStepGradientDescent< TElastix >::RegistrationPointer

Definition at line 102 of file elxRegularStepGradientDescent.h.

RegistrationType

template<class TElastix >

typedef Superclass2::RegistrationType elastix::RegularStepGradientDescent< TElastix >::RegistrationType

Definition at line 101 of file elxRegularStepGradientDescent.h.

Self

template<class TElastix >

typedef RegularStepGradientDescent elastix::RegularStepGradientDescent< TElastix >::Self

Standard ITK.

Definition at line 74 of file elxRegularStepGradientDescent.h.

Superclass1

template<class TElastix >

typedef RegularStepGradientDescentOptimizer elastix::RegularStepGradientDescent< TElastix >::Superclass1

Definition at line 75 of file elxRegularStepGradientDescent.h.

Superclass2

template<class TElastix >

typedef OptimizerBase< TElastix > elastix::RegularStepGradientDescent< TElastix >::Superclass2

Definition at line 76 of file elxRegularStepGradientDescent.h.

Constructor & Destructor Documentation

RegularStepGradientDescent() [1/2]

template<class TElastix >

elastix::RegularStepGradientDescent< TElastix >::RegularStepGradientDescent ( )

inlineprotected

Definition at line 128 of file elxRegularStepGradientDescent.h.

~RegularStepGradientDescent()

template<class TElastix >

elastix::RegularStepGradientDescent< TElastix >::~RegularStepGradientDescent ( )

inlineoverrideprotected

Definition at line 129 of file elxRegularStepGradientDescent.h.

RegularStepGradientDescent() [2/2]

template<class TElastix >

elastix::RegularStepGradientDescent< TElastix >::RegularStepGradientDescent ( const Self &  )

private

Member Function Documentation

AfterEachIteration()

template<class TElastix >

void elastix::RegularStepGradientDescent< TElastix >::AfterEachIteration ( void  )

overridevirtual

Reimplemented from elastix::BaseComponent.

AfterEachResolution()

template<class TElastix >

void elastix::RegularStepGradientDescent< TElastix >::AfterEachResolution ( void  )

overridevirtual

Reimplemented from elastix::BaseComponent.

AfterRegistration()

template<class TElastix >

void elastix::RegularStepGradientDescent< TElastix >::AfterRegistration ( void  )

overridevirtual

Reimplemented from elastix::BaseComponent.

BeforeEachResolution()

template<class TElastix >

void elastix::RegularStepGradientDescent< TElastix >::BeforeEachResolution ( void  )

overridevirtual

Reimplemented from elastix::BaseComponent.

BeforeRegistration()

template<class TElastix >

void elastix::RegularStepGradientDescent< TElastix >::BeforeRegistration ( void  )

overridevirtual

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

Reimplemented from elastix::BaseComponent.

elxClassNameMacro()

template<class TElastix >

elastix::RegularStepGradientDescent< TElastix >::elxClassNameMacro

(

"RegularStepGradientDescent< TElastix >"

)

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

GetClassName()

template<class TElastix >

virtual const char * elastix::RegularStepGradientDescent< TElastix >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from elastix::OptimizerBase< TElastix >.

New()

template<class TElastix >

static Pointer elastix::RegularStepGradientDescent< TElastix >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TElastix >

void elastix::RegularStepGradientDescent< TElastix >::operator= ( const Self &  )

private

SetInitialPosition()

template<class TElastix >

void elastix::RegularStepGradientDescent< TElastix >::SetInitialPosition ( const ParametersType &  param )

override

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