#include <elxMovingGenericPyramid.h>

Detailed Description

template<class TElastix>
class elastix::MovingGenericPyramid< TElastix >

A pyramid based on the itk::GenericMultiResolutionPyramidImageFilter.

It is generic since it has all functionality that the MovingRecursivePyramid, MovingShrinkingPyramid and MovingSmoothingPyramid have together. This pyramid has two separate schedules: one for size rescaling and one for the Gaussian smoothing factor sigma. In addition, it has an option to compute pyramid output per resolution, and not all at once, to reduce memory consumption.

The parameters used in this class are:

Parameters:

MovingImagePyramid: Select this pyramid as follows:
(MovingImagePyramid "MovingGenericImagePyramid")

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

ImagePyramidRescaleSchedule: rescale schedule for both pyramids

ImagePyramidSchedule: same as ImagePyramidRescaleSchedule

MovingImagePyramidSchedule: same as MovingImagePyramidRescaleSchedule

MovingImagePyramidSmoothingSchedule: sigma's for smoothing the moving image pyramid.
For each dimension, for each resolution level, the sigma of the moving image can be specified.
Syntax for 2D images:
(MovingImagePyramidSmoothingSchedule <reslevel0,dim0> <reslevel0,dim1> <reslevel1,dim0> <reslevel1,dim1> ...)
example: (MovingImagePyramidSmoothingSchedule 4 4 2 2 1 1)
Default: 0.5 x rescale_factor x moving_image_spacing.
If ImagePyramidSmoothingSchedule is specified, that schedule is used for both moving and moving image pyramid.

ImagePyramidSmoothingSchedule: smoothing schedule for both pyramids

ComputePyramidImagesPerResolution: Flag to specify if all resolution levels are computed at once, or per resolution. Latter saves memory.
example: (ComputePyramidImagesPerResolution "true")
Default false.

ImagePyramidUseShrinkImageFilter: Flag to specify if the ShrinkingImageFilter is used for rescaling the image, or the ResampleImageFilter. Shrinker is faster.
example: (ImagePyramidUseShrinkImageFilter "true")
Default false, so by default the resampler is used.

Definition at line 73 of file elxMovingGenericPyramid.h.

Inheritance diagram for elastix::MovingGenericPyramid< TElastix >:

Public Types
typedef Superclass2::ConfigurationPointer	ConfigurationPointer

typedef Superclass2::ConfigurationType	ConfigurationType

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass2::ElastixPointer	ElastixPointer

typedef Superclass2::ElastixType	ElastixType

typedef Superclass1::InputImageConstPointer	InputImageConstPointer

typedef Superclass1::InputImagePointer	InputImagePointer

typedef Superclass1::InputImageType	InputImageType

typedef Superclass2::ITKBaseType	ITKBaseType

typedef Superclass1::OutputImagePointer	OutputImagePointer

typedef Superclass1::OutputImageType	OutputImageType

typedef itk::SmartPointer< Self >	Pointer

typedef Superclass2::RegistrationPointer	RegistrationPointer

typedef Superclass2::RegistrationType	RegistrationType

typedef Superclass1::RescaleScheduleType	RescaleScheduleType

typedef Superclass1::ScheduleType	ScheduleType

typedef MovingGenericPyramid	Self

typedef Superclass1::SmoothingScheduleType	SmoothingScheduleType

typedef itk::GenericMultiResolutionPyramidImageFilter< typename MovingImagePyramidBase< TElastix >::InputImageType, typename MovingImagePyramidBase< TElastix >::OutputImageType >	Superclass1

typedef MovingImagePyramidBase< TElastix >	Superclass2

Public Types inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::InputImageConstPointer	InputImageConstPointer

typedef Superclass::InputImagePointer	InputImagePointer

typedef Superclass::InputImageType	InputImageType

typedef Superclass::OutputImagePointer	OutputImagePointer

typedef Superclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef SigmaArrayType	RescaleFactorArrayType

typedef ScheduleType	RescaleScheduleType

typedef NumericTraits< PixelType >::ScalarRealType	ScalarRealType

typedef Superclass::ScheduleType	ScheduleType

typedef GenericMultiResolutionPyramidImageFilter	Self

typedef FixedArray< ScalarRealType, itkGetStaticConstMacro(ImageDimension) >	SigmaArrayType

typedef Array2D< ScalarRealType >	SmoothingScheduleType

typedef Superclass::InputImageType::SpacingType	SpacingType

typedef MultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >	Superclass

typedef Superclass::Superclass	SuperSuperclass

Public Types inherited from elastix::MovingImagePyramidBase< TElastix >
typedef Superclass::ConfigurationPointer	ConfigurationPointer

typedef Superclass::ConfigurationType	ConfigurationType

typedef Superclass::ElastixPointer	ElastixPointer

typedef Superclass::ElastixType	ElastixType

typedef ElastixType::MovingImageType	InputImageType

typedef itk::MultiResolutionPyramidImageFilter< InputImageType, OutputImageType >	ITKBaseType

typedef ElastixType::MovingImageType	OutputImageType

typedef Superclass::RegistrationPointer	RegistrationPointer

typedef Superclass::RegistrationType	RegistrationType

typedef ITKBaseType::ScheduleType	ScheduleType

typedef MovingImagePyramidBase	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	BeforeEachResolution (void) override

	elxClassNameMacro ("MovingGenericImagePyramid")

virtual const char *	GetClassName () const

	itkStaticConstMacro (ImageDimension, unsigned int, Superclass1::ImageDimension)

void	SetMovingSchedule (void) override

Public Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
virtual void	ComputeOnlyForCurrentLevelOff ()

virtual void	ComputeOnlyForCurrentLevelOn ()

virtual const char *	GetClassName () const

virtual bool	GetComputeOnlyForCurrentLevel () const

virtual const unsigned int &	GetCurrentLevel ()

const RescaleScheduleType &	GetRescaleSchedule (void) const

virtual const SmoothingScheduleType &	GetSmoothingSchedule ()

	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)

	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)

virtual void	SetComputeOnlyForCurrentLevel (const bool _arg)

virtual void	SetCurrentLevel (unsigned int level)

void	SetNumberOfLevels (unsigned int num) override

virtual void	SetRescaleSchedule (const RescaleScheduleType &schedule)

virtual void	SetRescaleScheduleToUnity (void)

void	SetSchedule (const ScheduleType &schedule) override

virtual void	SetSmoothingSchedule (const SmoothingScheduleType &schedule)

virtual void	SetSmoothingScheduleToZero (void)

Public Member Functions inherited from elastix::MovingImagePyramidBase< TElastix >
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	SetMovingSchedule (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)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
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
	MovingGenericPyramid ()

	~MovingGenericPyramid () override

Protected Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
void	GenerateData (void) override

void	GenerateInputRequestedRegion (void) override

void	GenerateOutputInformation (void) override

void	GenerateOutputRequestedRegion (DataObject *output) override

	GenericMultiResolutionPyramidImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ReleaseOutputs (void)

	~GenericMultiResolutionPyramidImageFilter () override

Protected Member Functions inherited from elastix::MovingImagePyramidBase< TElastix >
	MovingImagePyramidBase ()

	~MovingImagePyramidBase () 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
	MovingGenericPyramid (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Protected Attributes inherited from itk::GenericMultiResolutionPyramidImageFilter< MovingImagePyramidBase< TElastix >::InputImageType, MovingImagePyramidBase< TElastix >::OutputImageType >
bool	m_ComputeOnlyForCurrentLevel

unsigned int	m_CurrentLevel

SmoothingScheduleType	m_SmoothingSchedule

bool	m_SmoothingScheduleDefined

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::MovingGenericPyramid< TElastix >::ConfigurationPointer

Definition at line 119 of file elxMovingGenericPyramid.h.

◆ ConfigurationType

template<class TElastix >

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

Definition at line 118 of file elxMovingGenericPyramid.h.

◆ ConstPointer

template<class TElastix >

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

Definition at line 88 of file elxMovingGenericPyramid.h.

◆ ElastixPointer

template<class TElastix >

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

Definition at line 117 of file elxMovingGenericPyramid.h.

◆ ElastixType

template<class TElastix >

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

Typedefs inherited from Elastix.

Definition at line 116 of file elxMovingGenericPyramid.h.

◆ InputImageConstPointer

template<class TElastix >

typedef Superclass1::InputImageConstPointer elastix::MovingGenericPyramid< TElastix >::InputImageConstPointer

Definition at line 110 of file elxMovingGenericPyramid.h.

◆ InputImagePointer

template<class TElastix >

typedef Superclass1::InputImagePointer elastix::MovingGenericPyramid< TElastix >::InputImagePointer

Definition at line 108 of file elxMovingGenericPyramid.h.

◆ InputImageType

template<class TElastix >

typedef Superclass1::InputImageType elastix::MovingGenericPyramid< TElastix >::InputImageType

Typedefs inherited from the superclass.

Definition at line 106 of file elxMovingGenericPyramid.h.

◆ ITKBaseType

template<class TElastix >

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

Definition at line 122 of file elxMovingGenericPyramid.h.

◆ OutputImagePointer

template<class TElastix >

typedef Superclass1::OutputImagePointer elastix::MovingGenericPyramid< TElastix >::OutputImagePointer

Definition at line 109 of file elxMovingGenericPyramid.h.

◆ OutputImageType

template<class TElastix >

typedef Superclass1::OutputImageType elastix::MovingGenericPyramid< TElastix >::OutputImageType

Definition at line 107 of file elxMovingGenericPyramid.h.

◆ Pointer

template<class TElastix >

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

Definition at line 87 of file elxMovingGenericPyramid.h.

◆ RegistrationPointer

template<class TElastix >

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

Definition at line 121 of file elxMovingGenericPyramid.h.

◆ RegistrationType

template<class TElastix >

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

Definition at line 120 of file elxMovingGenericPyramid.h.

◆ RescaleScheduleType

template<class TElastix >

typedef Superclass1::RescaleScheduleType elastix::MovingGenericPyramid< TElastix >::RescaleScheduleType

Definition at line 112 of file elxMovingGenericPyramid.h.

◆ ScheduleType

template<class TElastix >

typedef Superclass1::ScheduleType elastix::MovingGenericPyramid< TElastix >::ScheduleType

Definition at line 111 of file elxMovingGenericPyramid.h.

◆ Self

template<class TElastix >

typedef MovingGenericPyramid elastix::MovingGenericPyramid< TElastix >::Self

Standard ITK-stuff.

Definition at line 82 of file elxMovingGenericPyramid.h.

◆ SmoothingScheduleType

template<class TElastix >

typedef Superclass1::SmoothingScheduleType elastix::MovingGenericPyramid< TElastix >::SmoothingScheduleType

Definition at line 113 of file elxMovingGenericPyramid.h.

◆ Superclass1

template<class TElastix >

typedef itk::GenericMultiResolutionPyramidImageFilter< typename MovingImagePyramidBase< TElastix >::InputImageType, typename MovingImagePyramidBase< TElastix >::OutputImageType > elastix::MovingGenericPyramid< TElastix >::Superclass1

Definition at line 85 of file elxMovingGenericPyramid.h.

◆ Superclass2

template<class TElastix >

typedef MovingImagePyramidBase< TElastix > elastix::MovingGenericPyramid< TElastix >::Superclass2

Definition at line 86 of file elxMovingGenericPyramid.h.

Constructor & Destructor Documentation

◆ MovingGenericPyramid() [1/2]

template<class TElastix >

elastix::MovingGenericPyramid< TElastix >::MovingGenericPyramid ( )

inlineprotected

The constructor.

Definition at line 135 of file elxMovingGenericPyramid.h.

◆ ~MovingGenericPyramid()

template<class TElastix >

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

inlineoverrideprotected

The destructor.

Definition at line 137 of file elxMovingGenericPyramid.h.

◆ MovingGenericPyramid() [2/2]

template<class TElastix >

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

private

The private constructor.

Member Function Documentation

◆ BeforeEachResolution()

template<class TElastix >

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

overridevirtual

Update the current resolution level.

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

template<class TElastix >

elastix::MovingGenericPyramid< TElastix >::elxClassNameMacro ( "MovingGenericImagePyramid" )

Name of this class. Use this name in the parameter file to select this specific pyramid.
example: (MovingImagePyramid "MovingGenericImagePyramid")

◆ GetClassName()

template<class TElastix >

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

virtual

Run-time type information (and related methods).

Reimplemented from elastix::MovingImagePyramidBase< TElastix >.

Reimplemented in elastix::OpenCLMovingGenericPyramid< TElastix >.

◆ itkStaticConstMacro()

template<class TElastix >

elastix::MovingGenericPyramid< TElastix >::itkStaticConstMacro	(	ImageDimension	,
		unsigned int	,
		Superclass1::ImageDimension
	)

Get the ImageDimension.

◆ New()

template<class TElastix >

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

static

Method for creation through the object factory.

◆ operator=()

template<class TElastix >

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

private

The private copy constructor.

◆ SetMovingSchedule()

template<class TElastix >

void elastix::MovingGenericPyramid< TElastix >::SetMovingSchedule ( void )

overridevirtual

Method for setting the schedule. Override from MovingImagePyramidBase, since we now have two schedules, rescaling and smoothing.

Reimplemented from elastix::MovingImagePyramidBase< TElastix >.

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

◆ ElastixPointer

◆ ElastixType

◆ InputImageConstPointer

◆ InputImagePointer

◆ InputImageType

◆ ITKBaseType

◆ OutputImagePointer

◆ OutputImageType

◆ Pointer

◆ RegistrationPointer

◆ RegistrationType

◆ RescaleScheduleType

◆ ScheduleType

◆ Self

◆ SmoothingScheduleType

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ MovingGenericPyramid() [1/2]

◆ ~MovingGenericPyramid()

◆ MovingGenericPyramid() [2/2]

Member Function Documentation

◆ BeforeEachResolution()

◆ elxClassNameMacro()

◆ GetClassName()

◆ itkStaticConstMacro()

◆ New()

◆ operator=()

◆ SetMovingSchedule()