#include <elxOpenCLMovingGenericPyramid.h>

Detailed Description

template<class TElastix>
class elastix::OpenCLMovingGenericPyramid< TElastix >

A pyramid based on the itk::GenericMultiResolutionPyramidImageFilter. The parameters used in this class are:

Parameters:

Pyramid: Select this pyramid as follows:
(MovingImagePyramid "OpenCLMovingGenericImagePyramid")

Pyramid: Enable the OpenCL pyramid as follows:
(OpenCLMovingGenericImagePyramidUseOpenCL "true")

Author: Denis P. Shamonin and Marius Staring. Division of Image Processing, Department of Radiology, Leiden, The Netherlands

Note: This work was funded by the Netherlands Organisation for Scientific Research (NWO NRG-2010.02 and NWO 639.021.124).

See also: MovingGenericPyramid

Definition at line 48 of file elxOpenCLMovingGenericPyramid.h.

Inheritance diagram for elastix::OpenCLMovingGenericPyramid< TElastix >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef GPUInputImageType::Pointer	GPUInputImagePointer

typedef itk::GPUImage< InputImagePixelType, InputImageType::ImageDimension >	GPUInputImageType

typedef itk::GPUImage< OutputImagePixelType, OutputImageType::ImageDimension >	GPUOutputImageType

typedef GPUPyramidType::Pointer	GPUPyramidPointer

typedef itk::GenericMultiResolutionPyramidImageFilter< GPUInputImageType, GPUOutputImageType, float >	GPUPyramidType

typedef Superclass1::InputImageType::PixelType	InputImagePixelType

typedef Superclass1::InputImageType	InputImageType

typedef itk::ObjectFactoryBase::Pointer	ObjectFactoryBasePointer

typedef Superclass1::OutputImageType::PixelType	OutputImagePixelType

typedef Superclass1::OutputImageType	OutputImageType

typedef itk::SmartPointer< Self >	Pointer

typedef OpenCLMovingGenericPyramid	Self

typedef MovingGenericPyramid< TElastix >	Superclass

typedef MovingGenericPyramid< TElastix >::Superclass1	Superclass1

typedef MovingGenericPyramid< TElastix >::Superclass2	Superclass2

Public Types inherited from elastix::MovingGenericPyramid< TElastix >
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
virtual void	BeforeRegistration (void)

	elxClassNameMacro ("OpenCLMovingGenericImagePyramid")

virtual const char *	GetClassName () const

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

virtual void	ReadFromFile (void)

Public Member Functions inherited from elastix::MovingGenericPyramid< TElastix >
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 elastix::MovingGenericPyramid< TElastix >
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
void	BeforeGenerateData (void)

virtual void	GenerateData (void)

	OpenCLMovingGenericPyramid ()

virtual	~OpenCLMovingGenericPyramid ()

Protected Member Functions inherited from elastix::MovingGenericPyramid< TElastix >
	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
	OpenCLMovingGenericPyramid (const Self &)

void	operator= (const Self &)

void	RegisterFactories (void)

void	ReportToLog (void)

void	SwitchingToCPUAndReport (const bool configError)

void	UnregisterFactories (void)

Private Attributes
bool	m_ContextCreated

std::vector< ObjectFactoryBasePointer >	m_Factories

GPUPyramidPointer	m_GPUPyramid

bool	m_GPUPyramidCreated

bool	m_GPUPyramidReady

bool	m_UseOpenCL

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

◆ ConstPointer

template<class TElastix >

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

Definition at line 59 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUInputImagePointer

template<class TElastix >

typedef GPUInputImageType::Pointer elastix::OpenCLMovingGenericPyramid< TElastix >::GPUInputImagePointer

Definition at line 88 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUInputImageType

template<class TElastix >

typedef itk::GPUImage< InputImagePixelType, InputImageType::ImageDimension > elastix::OpenCLMovingGenericPyramid< TElastix >::GPUInputImageType

GPU Typedefs for GPU image and GPU filter.

Definition at line 87 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUOutputImageType

template<class TElastix >

typedef itk::GPUImage< OutputImagePixelType, OutputImageType::ImageDimension > elastix::OpenCLMovingGenericPyramid< TElastix >::GPUOutputImageType

Definition at line 90 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUPyramidPointer

template<class TElastix >

typedef GPUPyramidType::Pointer elastix::OpenCLMovingGenericPyramid< TElastix >::GPUPyramidPointer

Definition at line 95 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUPyramidType

template<class TElastix >

typedef itk::GenericMultiResolutionPyramidImageFilter< GPUInputImageType, GPUOutputImageType, float > elastix::OpenCLMovingGenericPyramid< TElastix >::GPUPyramidType

Definition at line 94 of file elxOpenCLMovingGenericPyramid.h.

◆ InputImagePixelType

template<class TElastix >

typedef Superclass1::InputImageType::PixelType elastix::OpenCLMovingGenericPyramid< TElastix >::InputImagePixelType

Definition at line 79 of file elxOpenCLMovingGenericPyramid.h.

◆ InputImageType

template<class TElastix >

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

Typedefs inherited from the superclass.

Definition at line 77 of file elxOpenCLMovingGenericPyramid.h.

◆ ObjectFactoryBasePointer

template<class TElastix >

typedef itk::ObjectFactoryBase::Pointer elastix::OpenCLMovingGenericPyramid< TElastix >::ObjectFactoryBasePointer

Typedefs for factory.

Definition at line 83 of file elxOpenCLMovingGenericPyramid.h.

◆ OutputImagePixelType

template<class TElastix >

typedef Superclass1::OutputImageType::PixelType elastix::OpenCLMovingGenericPyramid< TElastix >::OutputImagePixelType

Definition at line 80 of file elxOpenCLMovingGenericPyramid.h.

◆ OutputImageType

template<class TElastix >

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

Definition at line 78 of file elxOpenCLMovingGenericPyramid.h.

◆ Pointer

template<class TElastix >

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

Definition at line 58 of file elxOpenCLMovingGenericPyramid.h.

◆ Self

template<class TElastix >

typedef OpenCLMovingGenericPyramid elastix::OpenCLMovingGenericPyramid< TElastix >::Self

Standard ITK-stuff.

Definition at line 54 of file elxOpenCLMovingGenericPyramid.h.

◆ Superclass

template<class TElastix >

typedef MovingGenericPyramid< TElastix > elastix::OpenCLMovingGenericPyramid< TElastix >::Superclass

Definition at line 55 of file elxOpenCLMovingGenericPyramid.h.

◆ Superclass1

template<class TElastix >

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

Definition at line 56 of file elxOpenCLMovingGenericPyramid.h.

◆ Superclass2

template<class TElastix >

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

Definition at line 57 of file elxOpenCLMovingGenericPyramid.h.

Constructor & Destructor Documentation

◆ OpenCLMovingGenericPyramid() [1/2]

template<class TElastix >

elastix::OpenCLMovingGenericPyramid< TElastix >::OpenCLMovingGenericPyramid ( )

protected

The constructor.

◆ ~OpenCLMovingGenericPyramid()

template<class TElastix >

virtual elastix::OpenCLMovingGenericPyramid< TElastix >::~OpenCLMovingGenericPyramid ( )

inlineprotectedvirtual

The destructor.

Definition at line 114 of file elxOpenCLMovingGenericPyramid.h.

◆ OpenCLMovingGenericPyramid() [2/2]

template<class TElastix >

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

private

The private constructor.

Member Function Documentation

◆ BeforeGenerateData()

template<class TElastix >

void elastix::OpenCLMovingGenericPyramid< TElastix >::BeforeGenerateData ( void )

protected

This method performs all configuration for GPU pyramid.

◆ BeforeRegistration()

template<class TElastix >

virtual void elastix::OpenCLMovingGenericPyramid< TElastix >::BeforeRegistration ( void )

virtual

Do some things before registration.

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

template<class TElastix >

elastix::OpenCLMovingGenericPyramid< TElastix >::elxClassNameMacro ( "OpenCLMovingGenericImagePyramid" )

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

◆ GenerateData()

template<class TElastix >

virtual void elastix::OpenCLMovingGenericPyramid< TElastix >::GenerateData ( void )

protectedvirtual

Executes GPU pyramid.

◆ GetClassName()

template<class TElastix >

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

virtual

Run-time type information (and related methods).

Reimplemented from elastix::MovingGenericPyramid< TElastix >.

◆ itkStaticConstMacro()

template<class TElastix >

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

Get the ImageDimension.

◆ New()

template<class TElastix >

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

static

Method for creation through the object factory.

◆ operator=()

template<class TElastix >

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

private

The private copy constructor.

◆ ReadFromFile()

template<class TElastix >

virtual void elastix::OpenCLMovingGenericPyramid< TElastix >::ReadFromFile ( void )

virtual

Function to read parameters from a file.

◆ RegisterFactories()

template<class TElastix >

void elastix::OpenCLMovingGenericPyramid< TElastix >::RegisterFactories ( void )

private

Register/Unregister factories.

◆ ReportToLog()

template<class TElastix >

void elastix::OpenCLMovingGenericPyramid< TElastix >::ReportToLog ( void )

private

Helper method to report to elastix log.

◆ SwitchingToCPUAndReport()

template<class TElastix >

void elastix::OpenCLMovingGenericPyramid< TElastix >::SwitchingToCPUAndReport ( const bool configError )

private

Helper method to report switching to CPU mode.

◆ UnregisterFactories()

template<class TElastix >

void elastix::OpenCLMovingGenericPyramid< TElastix >::UnregisterFactories ( void )

private

Field Documentation

◆ m_ContextCreated

template<class TElastix >

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_ContextCreated

private

Definition at line 137 of file elxOpenCLMovingGenericPyramid.h.

◆ m_Factories

template<class TElastix >

std::vector< ObjectFactoryBasePointer > elastix::OpenCLMovingGenericPyramid< TElastix >::m_Factories

private

Definition at line 139 of file elxOpenCLMovingGenericPyramid.h.

◆ m_GPUPyramid

template<class TElastix >

GPUPyramidPointer elastix::OpenCLMovingGenericPyramid< TElastix >::m_GPUPyramid

private

Definition at line 134 of file elxOpenCLMovingGenericPyramid.h.

◆ m_GPUPyramidCreated

template<class TElastix >

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_GPUPyramidCreated

private

Definition at line 136 of file elxOpenCLMovingGenericPyramid.h.

◆ m_GPUPyramidReady

template<class TElastix >

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_GPUPyramidReady

private

Definition at line 135 of file elxOpenCLMovingGenericPyramid.h.

◆ m_UseOpenCL

template<class TElastix >

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_UseOpenCL

private

Definition at line 138 of file elxOpenCLMovingGenericPyramid.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ GPUInputImagePointer

◆ GPUInputImageType

◆ GPUOutputImageType

◆ GPUPyramidPointer

◆ GPUPyramidType

◆ InputImagePixelType

◆ InputImageType

◆ ObjectFactoryBasePointer

◆ OutputImagePixelType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ OpenCLMovingGenericPyramid() [1/2]

◆ ~OpenCLMovingGenericPyramid()

◆ OpenCLMovingGenericPyramid() [2/2]

Member Function Documentation

◆ BeforeGenerateData()

◆ BeforeRegistration()

◆ elxClassNameMacro()

◆ GenerateData()

◆ GetClassName()

◆ itkStaticConstMacro()

◆ New()

◆ operator=()

◆ ReadFromFile()

◆ RegisterFactories()

◆ ReportToLog()

◆ SwitchingToCPUAndReport()

◆ UnregisterFactories()

Field Documentation

◆ m_ContextCreated

◆ m_Factories

◆ m_GPUPyramid

◆ m_GPUPyramidCreated

◆ m_GPUPyramidReady

◆ m_UseOpenCL