#include <elxSimplex.h>

Detailed Description

template<class TElastix>
class elastix::Simplex< TElastix >

An optimizer based on Simplex...

This optimizer is a wrap around the itk::AmoebaOptimizer. 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 itkAmoebaOptimizer (in the ITK-manual).

See also: ImprovedSimplexOptimizer

Definition at line 41 of file elxSimplex.h.

Inheritance diagram for elastix::Simplex< 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 Simplex	Self

typedef AmoebaOptimizer	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 ("Simplex")

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
	Simplex ()

	~Simplex () 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 &)

	Simplex (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::Simplex< TElastix >::ConfigurationPointer

Definition at line 76 of file elxSimplex.h.

◆ ConfigurationType

template<class TElastix >

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

Definition at line 75 of file elxSimplex.h.

◆ ConstPointer

template<class TElastix >

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

Definition at line 54 of file elxSimplex.h.

◆ CostFunctionPointer

template<class TElastix >

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

Definition at line 70 of file elxSimplex.h.

◆ CostFunctionType

template<class TElastix >

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

Typedef's inherited from Superclass1.

Definition at line 69 of file elxSimplex.h.

◆ ElastixPointer

template<class TElastix >

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

Definition at line 74 of file elxSimplex.h.

◆ ElastixType

template<class TElastix >

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

Typedef's inherited from Elastix.

Definition at line 73 of file elxSimplex.h.

◆ ITKBaseType

template<class TElastix >

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

Definition at line 79 of file elxSimplex.h.

◆ ParametersType

template<class TElastix >

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

Typedef for the ParametersType.

Definition at line 82 of file elxSimplex.h.

◆ Pointer

template<class TElastix >

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

Definition at line 53 of file elxSimplex.h.

◆ RegistrationPointer

template<class TElastix >

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

Definition at line 78 of file elxSimplex.h.

◆ RegistrationType

template<class TElastix >

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

Definition at line 77 of file elxSimplex.h.

◆ Self

template<class TElastix >

typedef Simplex elastix::Simplex< TElastix >::Self

Standard ITK.

Definition at line 50 of file elxSimplex.h.

◆ Superclass1

template<class TElastix >

typedef AmoebaOptimizer elastix::Simplex< TElastix >::Superclass1

Definition at line 51 of file elxSimplex.h.

◆ Superclass2

template<class TElastix >

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

Definition at line 52 of file elxSimplex.h.

Constructor & Destructor Documentation

◆ Simplex() [1/2]

template<class TElastix >

elastix::Simplex< TElastix >::Simplex ( )

inlineprotected

Definition at line 104 of file elxSimplex.h.

◆ ~Simplex()

template<class TElastix >

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

inlineoverrideprotected

Definition at line 105 of file elxSimplex.h.

◆ Simplex() [2/2]

template<class TElastix >

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

private

Member Function Documentation

◆ AfterEachIteration()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ AfterEachResolution()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ AfterRegistration()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ BeforeEachResolution()

template<class TElastix >

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

overridevirtual

Reimplemented from elastix::BaseComponent.

◆ BeforeRegistration()

template<class TElastix >

void elastix::Simplex< 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::Simplex< TElastix >::elxClassNameMacro ( "Simplex< TElastix >" )

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

◆ GetClassName()

template<class TElastix >

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

virtual

Run-time type information (and related methods).

Reimplemented from elastix::OptimizerBase< TElastix >.

◆ New()

template<class TElastix >

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

static

Method for creation through the object factory.

◆ operator=()

template<class TElastix >

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

private

◆ SetInitialPosition()

template<class TElastix >

void elastix::Simplex< 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.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConfigurationPointer

◆ ConfigurationType

◆ ConstPointer

◆ CostFunctionPointer

◆ CostFunctionType

◆ ElastixPointer

◆ ElastixType

◆ ITKBaseType

◆ ParametersType

◆ Pointer

◆ RegistrationPointer

◆ RegistrationType

◆ Self

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ Simplex() [1/2]

◆ ~Simplex()

◆ Simplex() [2/2]

Member Function Documentation

◆ AfterEachIteration()

◆ AfterEachResolution()

◆ AfterRegistration()

◆ BeforeEachResolution()

◆ BeforeRegistration()

◆ elxClassNameMacro()

◆ GetClassName()

◆ New()

◆ operator=()

◆ SetInitialPosition()