elastix::FixedImagePyramidBase< TElastix > Class Template Reference

#include <elxFixedImagePyramidBase.h>

Detailed Description

template<class TElastix>
class elastix::FixedImagePyramidBase< TElastix >

This class is the elastix base class for all FixedImagePyramids.

This class contains all the common functionality for FixedImagePyramids.

Parameters:

FixedImagePyramidSchedule: downsampling factors for the fixed image pyramid.
For each dimension, for each resolution level, the downsampling factor of the fixed image can be specified.
Syntax for 2D images:
(FixedImagePyramidSchedule <reslevel0,dim0> <reslevel0,dim1> <reslevel1,dim0> <reslevel1,dim1> ...)
example: (FixedImagePyramidSchedule 4 4 2 2 1 1)
Default: isotropic, halved in each resolution, so, like in the example. If ImagePyramidSchedule is specified, that schedule is used for both fixed and moving image pyramid.

ImagePyramidSchedule: downsampling factors for fixed and moving image pyramids.
example: (ImagePyramidSchedule 4 4 2 2 1 1)
Used as a default when FixedImagePyramidSchedule is not specified. If both are omitted, a default schedule is assumed: isotropic, halved in each resolution, so, like in the example.

WritePyramidImagesAfterEachResolution: ...
example: (WritePyramidImagesAfterEachResolution "true")
default "false".

Definition at line 58 of file elxFixedImagePyramidBase.h.

Inheritance diagram for elastix::FixedImagePyramidBase< TElastix >:

Public Types
typedef Superclass::ConfigurationPointer	ConfigurationPointer
typedef Superclass::ConfigurationType	ConfigurationType
typedef Superclass::ElastixPointer	ElastixPointer
typedef Superclass::ElastixType	ElastixType
typedef ElastixType::FixedImageType	InputImageType
typedef itk::MultiResolutionPyramidImageFilter< InputImageType, OutputImageType >	ITKBaseType
typedef ElastixType::FixedImageType	OutputImageType
typedef Superclass::RegistrationPointer	RegistrationPointer
typedef Superclass::RegistrationType	RegistrationType
typedef ITKBaseType::ScheduleType	ScheduleType
typedef FixedImagePyramidBase	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	BeforeEachResolutionBase (void) override
void	BeforeRegistrationBase (void) override
virtual ITKBaseType *	GetAsITKBaseType (void)
virtual const ITKBaseType *	GetAsITKBaseType (void) const
virtual const char *	GetClassName () const
virtual void	SetFixedSchedule (void)
virtual void	WritePyramidImage (const std::string &filename, const unsigned int &level)
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)

Protected Member Functions
	FixedImagePyramidBase ()
	~FixedImagePyramidBase () 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
	FixedImagePyramidBase (const Self &)
void	operator= (const Self &)

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 ()
Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
ConfigurationPointer	m_Configuration {}
ElastixPointer	m_Elastix {}
RegistrationPointer	m_Registration {}

Member Typedef Documentation

ConfigurationPointer

template<class TElastix >

typedef Superclass::ConfigurationPointer elastix::FixedImagePyramidBase< TElastix >::ConfigurationPointer

Definition at line 73 of file elxFixedImagePyramidBase.h.

ConfigurationType

template<class TElastix >

typedef Superclass::ConfigurationType elastix::FixedImagePyramidBase< TElastix >::ConfigurationType

Definition at line 72 of file elxFixedImagePyramidBase.h.

ElastixPointer

template<class TElastix >

typedef Superclass::ElastixPointer elastix::FixedImagePyramidBase< TElastix >::ElastixPointer

Definition at line 71 of file elxFixedImagePyramidBase.h.

ElastixType

template<class TElastix >

typedef Superclass::ElastixType elastix::FixedImagePyramidBase< TElastix >::ElastixType

Typedefs inherited from the superclass.

Definition at line 70 of file elxFixedImagePyramidBase.h.

InputImageType

template<class TElastix >

typedef ElastixType::FixedImageType elastix::FixedImagePyramidBase< TElastix >::InputImageType

Typedefs inherited from Elastix.

Definition at line 78 of file elxFixedImagePyramidBase.h.

ITKBaseType

template<class TElastix >

typedef itk::MultiResolutionPyramidImageFilter< InputImageType, OutputImageType > elastix::FixedImagePyramidBase< TElastix >::ITKBaseType

Other typedef's.

Definition at line 83 of file elxFixedImagePyramidBase.h.

OutputImageType

template<class TElastix >

typedef ElastixType::FixedImageType elastix::FixedImagePyramidBase< TElastix >::OutputImageType

Definition at line 79 of file elxFixedImagePyramidBase.h.

RegistrationPointer

template<class TElastix >

typedef Superclass::RegistrationPointer elastix::FixedImagePyramidBase< TElastix >::RegistrationPointer

Definition at line 75 of file elxFixedImagePyramidBase.h.

RegistrationType

template<class TElastix >

typedef Superclass::RegistrationType elastix::FixedImagePyramidBase< TElastix >::RegistrationType

Definition at line 74 of file elxFixedImagePyramidBase.h.

ScheduleType

template<class TElastix >

typedef ITKBaseType::ScheduleType elastix::FixedImagePyramidBase< TElastix >::ScheduleType

Typedef's from ITKBaseType.

Definition at line 86 of file elxFixedImagePyramidBase.h.

Self

template<class TElastix >

typedef FixedImagePyramidBase elastix::FixedImagePyramidBase< TElastix >::Self

Standard ITK-stuff.

Definition at line 63 of file elxFixedImagePyramidBase.h.

Superclass

template<class TElastix >

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

Definition at line 64 of file elxFixedImagePyramidBase.h.

Constructor & Destructor Documentation

FixedImagePyramidBase() [1/2]

template<class TElastix >

elastix::FixedImagePyramidBase< TElastix >::FixedImagePyramidBase ( )

inlineprotected

The constructor.

Definition at line 122 of file elxFixedImagePyramidBase.h.

~FixedImagePyramidBase()

template<class TElastix >

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

inlineoverrideprotected

The destructor.

Definition at line 124 of file elxFixedImagePyramidBase.h.

FixedImagePyramidBase() [2/2]

template<class TElastix >

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

private

The private constructor.

Member Function Documentation

BeforeEachResolutionBase()

template<class TElastix >

void elastix::FixedImagePyramidBase< TElastix >::BeforeEachResolutionBase ( void  )

overridevirtual

Execute stuff before each resolution:

• Write the pyramid image to file.

Reimplemented from elastix::BaseComponent.

BeforeRegistrationBase()

template<class TElastix >

void elastix::FixedImagePyramidBase< TElastix >::BeforeRegistrationBase ( void  )

overridevirtual

Execute stuff before the actual registration:

• Set the schedule of the fixed image pyramid.

Reimplemented from elastix::BaseComponent.

GetAsITKBaseType() [1/2]

template<class TElastix >

virtual ITKBaseType * elastix::FixedImagePyramidBase< TElastix >::GetAsITKBaseType ( void  )

inlinevirtual

Cast to ITKBaseType.

Definition at line 89 of file elxFixedImagePyramidBase.h.

GetAsITKBaseType() [2/2]

template<class TElastix >

virtual const ITKBaseType * elastix::FixedImagePyramidBase< TElastix >::GetAsITKBaseType ( void  ) const

inlinevirtual

Cast to ITKBaseType, to use in const functions.

Definition at line 96 of file elxFixedImagePyramidBase.h.

GetClassName()

template<class TElastix >

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

virtual

Run-time type information (and related methods).

Reimplemented in elastix::FixedGenericPyramid< TElastix >, elastix::FixedRecursivePyramid< TElastix >, elastix::FixedShrinkingPyramid< TElastix >, elastix::FixedSmoothingPyramid< TElastix >, and elastix::OpenCLFixedGenericPyramid< TElastix >.

operator=()

template<class TElastix >

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

private

The private copy constructor.

SetFixedSchedule()

template<class TElastix >

virtual void elastix::FixedImagePyramidBase< TElastix >::SetFixedSchedule ( void  )

virtual

Method for setting the schedule.

Reimplemented in elastix::FixedGenericPyramid< TElastix >.

WritePyramidImage()

template<class TElastix >

virtual void elastix::FixedImagePyramidBase< TElastix >::WritePyramidImage ( const std::string &  filename, const unsigned int &  level  )

virtual

Method to write the pyramid image.