elastix::BaseComponentSE< TElastix > Class Template Reference

#include <elxBaseComponentSE.h>

Detailed Description

template<class TElastix>
class elastix::BaseComponentSE< TElastix >

The BaseComponentSE class is a base class for elastix components that provides some basic functionality.

Most elastix component will not directly inherit from the elx::BaseComponent class but from this one, since it adds some methods that most methods need anyway, such as Set/GetElastix, Set/GetConfiguration.

See also

BaseComponent

Definition at line 44 of file elxBaseComponentSE.h.

Inheritance diagram for elastix::BaseComponentSE< TElastix >:

Public Types
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
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)

Protected Member Functions
	BaseComponentSE ()=default
	~BaseComponentSE () override=default
Protected Member Functions inherited from elastix::BaseComponent
	BaseComponent ()=default
virtual	~BaseComponent ()=default

Protected Attributes
ConfigurationPointer	m_Configuration {}
ElastixPointer	m_Elastix {}
RegistrationPointer	m_Registration {}

Additional Inherited Members
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 ()

Member Typedef Documentation

ConfigurationPointer

template<class TElastix >

typedef Configuration::Pointer elastix::BaseComponentSE< TElastix >::ConfigurationPointer

Definition at line 59 of file elxBaseComponentSE.h.

ConfigurationType

template<class TElastix >

typedef Configuration elastix::BaseComponentSE< TElastix >::ConfigurationType

ConfigurationType.

Definition at line 58 of file elxBaseComponentSE.h.

ElastixPointer

template<class TElastix >

typedef itk::WeakPointer< ElastixType > elastix::BaseComponentSE< TElastix >::ElastixPointer

Definition at line 55 of file elxBaseComponentSE.h.

ElastixType

template<class TElastix >

typedef TElastix elastix::BaseComponentSE< TElastix >::ElastixType

Elastix typedef's.

Definition at line 54 of file elxBaseComponentSE.h.

RegistrationPointer

template<class TElastix >

typedef RegistrationType* elastix::BaseComponentSE< TElastix >::RegistrationPointer

Definition at line 65 of file elxBaseComponentSE.h.

RegistrationType

template<class TElastix >

typedef ElastixType::RegistrationBaseType elastix::BaseComponentSE< TElastix >::RegistrationType

RegistrationType; NB: this is the elx::RegistrationBase not an itk::Object or something like that.

Definition at line 64 of file elxBaseComponentSE.h.

Self

template<class TElastix >

typedef BaseComponentSE elastix::BaseComponentSE< TElastix >::Self

Standard stuff.

Definition at line 50 of file elxBaseComponentSE.h.

Superclass

template<class TElastix >

typedef BaseComponent elastix::BaseComponentSE< TElastix >::Superclass

Definition at line 51 of file elxBaseComponentSE.h.

Constructor & Destructor Documentation

BaseComponentSE()

template<class TElastix >

elastix::BaseComponentSE< TElastix >::BaseComponentSE ( )

protecteddefault

~BaseComponentSE()

template<class TElastix >

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

overrideprotecteddefault

Member Function Documentation

GetConfiguration()

template<class TElastix >

ConfigurationType * elastix::BaseComponentSE< TElastix >::GetConfiguration ( void  ) const

inline

itkGetModifiableObjectMacro(Configuration, ConfigurationType); The configuration object provides functionality to read parameters and command line arguments.

Definition at line 94 of file elxBaseComponentSE.h.

GetElastix()

template<class TElastix >

ElastixType * elastix::BaseComponentSE< TElastix >::GetElastix ( void  ) const

inline

itkGetModifiableObjectMacro( Elastix, ElastixType ); without the itkDebug call.

Definition at line 84 of file elxBaseComponentSE.h.

GetRegistration()

template<class TElastix >

RegistrationPointer elastix::BaseComponentSE< TElastix >::GetRegistration ( void  ) const

inline

Get a pointer to the Registration component. This is a convenience function, since the registration component is needed often by other components. It could be accessed also via GetElastix->GetElxRegistrationBase().

Definition at line 108 of file elxBaseComponentSE.h.

ITK_DISALLOW_COPY_AND_ASSIGN()

template<class TElastix >

elastix::BaseComponentSE< TElastix >::ITK_DISALLOW_COPY_AND_ASSIGN

(

BaseComponentSE< TElastix >

)

SetConfiguration()

template<class TElastix >

void elastix::BaseComponentSE< TElastix >::SetConfiguration

(

ConfigurationType *

_arg

)

Set the configuration. Added for transformix.

SetElastix()

template<class TElastix >

void elastix::BaseComponentSE< TElastix >::SetElastix

(

ElastixType *

_arg

)

Get/Set functions for Elastix. The Set-functions cannot be defined with the itkSetObjectMacro, since this class does not derive from itk::Object and thus does not have a Modified() method.

This method checks if this instance of the class can be casted (dynamically) to an itk::Object. If yes, it calls Modified()

Besides setting m_Elastix, this method also sets m_Configuration and m_Registration.

Field Documentation

m_Configuration

template<class TElastix >

ConfigurationPointer elastix::BaseComponentSE< TElastix >::m_Configuration {}

protected

Definition at line 120 of file elxBaseComponentSE.h.

m_Elastix

template<class TElastix >

ElastixPointer elastix::BaseComponentSE< TElastix >::m_Elastix {}

protected

Definition at line 119 of file elxBaseComponentSE.h.

m_Registration

template<class TElastix >

RegistrationPointer elastix::BaseComponentSE< TElastix >::m_Registration {}

protected

Definition at line 121 of file elxBaseComponentSE.h.