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
using	ElastixType
using	InputImageType = typename ElastixType::FixedImageType
using	ITKBaseType = itk::MultiResolutionPyramidImageFilter<InputImageType, OutputImageType>
using	OutputImageType = typename ElastixType::FixedImageType
using	RegistrationType
using	ScheduleType = typename ITKBaseType::ScheduleType
using	Self = FixedImagePyramidBase
using	Superclass = BaseComponentSE<TElastix>
Public Types inherited from elastix::BaseComponentSE< TElastix >
using	ElastixType = TElastix
using	RegistrationType = typename ElastixType::RegistrationBaseType
using	Self = BaseComponentSE
using	Superclass = BaseComponent

Public Member Functions
void	BeforeEachResolutionBase () override
void	BeforeRegistrationBase () override
ITKBaseType *	GetAsITKBaseType ()
const ITKBaseType *	GetAsITKBaseType () const
virtual const char *	GetClassName () const
	ITK_DISALLOW_COPY_AND_MOVE (FixedImagePyramidBase)
virtual void	SetFixedSchedule ()
void	WritePyramidImage (const std::string &filename, const unsigned int level)
Public Member Functions inherited from elastix::BaseComponentSE< TElastix >
void	AddTargetCellToIterationInfo (const char *const name)
const Configuration *	GetConfiguration () const
ElastixType *	GetElastix () const
auto &	GetIterationInfoAt (const char *const name)
RegistrationType *	GetRegistration () const
	ITK_DISALLOW_COPY_AND_MOVE (BaseComponentSE)
void	RemoveTargetCellFromIterationInfo (const char *const name)
void	SetConfiguration (const Configuration *_arg)
void	SetElastix (ElastixType *_arg)
Public Member Functions inherited from elastix::BaseComponent
virtual void	AfterEachIteration ()
virtual void	AfterEachIterationBase ()
virtual void	AfterEachResolution ()
virtual void	AfterEachResolutionBase ()
virtual void	AfterRegistration ()
virtual void	AfterRegistrationBase ()
virtual int	BeforeAll ()
virtual int	BeforeAllBase ()
virtual void	BeforeEachResolution ()
virtual void	BeforeRegistration ()
virtual const char *	elxGetClassName () const
const char *	GetComponentLabel () const
	ITK_DISALLOW_COPY_AND_MOVE (BaseComponent)
	itkTypeMacroNoParent (BaseComponent)
void	SetComponentLabel (const char *label, unsigned int idx)

Protected Member Functions
	FixedImagePyramidBase ()=default
	~FixedImagePyramidBase () override=default
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
	elxDeclarePureVirtualGetSelfMacro (ITKBaseType)

Additional Inherited Members
Static Public Member Functions inherited from elastix::BaseComponent
template<typename TBaseComponent >
static auto	AsITKBaseType (TBaseComponent *const baseComponent) -> decltype(baseComponent->GetAsITKBaseType())
static void	InitializeElastixExecutable ()
static bool	IsElastixLibrary ()
Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
Configuration::ConstPointer	m_Configuration {}
itk::WeakPointer< TElastix >	m_Elastix {}
RegistrationType *	m_Registration {}

Member Typedef Documentation

ElastixType

template<class TElastix >

using elastix::BaseComponentSE< TElastix >::ElastixType

Elastix typedef.

Definition at line 57 of file elxBaseComponentSE.h.

InputImageType

template<class TElastix >

using elastix::FixedImagePyramidBase< TElastix >::InputImageType = typename ElastixType::FixedImageType

Typedefs inherited from Elastix.

Definition at line 75 of file elxFixedImagePyramidBase.h.

ITKBaseType

template<class TElastix >

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

Other typedef's.

Definition at line 79 of file elxFixedImagePyramidBase.h.

OutputImageType

template<class TElastix >

using elastix::FixedImagePyramidBase< TElastix >::OutputImageType = typename ElastixType::FixedImageType

Definition at line 76 of file elxFixedImagePyramidBase.h.

RegistrationType

template<class TElastix >

using elastix::BaseComponentSE< TElastix >::RegistrationType

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

Definition at line 62 of file elxBaseComponentSE.h.

ScheduleType

template<class TElastix >

using elastix::FixedImagePyramidBase< TElastix >::ScheduleType = typename ITKBaseType::ScheduleType

Typedef's from ITKBaseType.

Definition at line 82 of file elxFixedImagePyramidBase.h.

Self

template<class TElastix >

using elastix::FixedImagePyramidBase< TElastix >::Self = FixedImagePyramidBase

Standard ITK-stuff.

Definition at line 64 of file elxFixedImagePyramidBase.h.

Superclass

template<class TElastix >

using elastix::FixedImagePyramidBase< TElastix >::Superclass = BaseComponentSE<TElastix>

Definition at line 65 of file elxFixedImagePyramidBase.h.

Constructor & Destructor Documentation

FixedImagePyramidBase()

template<class TElastix >

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

protecteddefault

The constructor.

~FixedImagePyramidBase()

template<class TElastix >

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

overrideprotecteddefault

The destructor.

Member Function Documentation

BeforeEachResolutionBase()

template<class TElastix >

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

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

overridevirtual

Execute stuff before the actual registration:

• Set the schedule of the fixed image pyramid.

Reimplemented from elastix::BaseComponent.

elxDeclarePureVirtualGetSelfMacro()

template<class TElastix >

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

private

GetAsITKBaseType() [1/2]

template<class TElastix >

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

inline

Retrieves this object as ITKBaseType.

Definition at line 86 of file elxFixedImagePyramidBase.h.

GetAsITKBaseType() [2/2]

template<class TElastix >

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

inline

Retrieves this object as ITKBaseType, to use in const functions.

Definition at line 94 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 >.

ITK_DISALLOW_COPY_AND_MOVE()

template<class TElastix >

elastix::FixedImagePyramidBase< TElastix >::ITK_DISALLOW_COPY_AND_MOVE

(

FixedImagePyramidBase< TElastix >

)

SetFixedSchedule()

template<class TElastix >

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

virtual

Method for setting the schedule.

Reimplemented in elastix::FixedGenericPyramid< TElastix >.

WritePyramidImage()

template<class TElastix >

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

Method to write the pyramid image.