#include <elxOpenCLMovingGenericPyramid.h>

Detailed Description

template<typename 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 >:

[legend]

Public Types
using	ConstPointer = itk::SmartPointer<const Self>
using	GPUInputImagePointer = typename GPUInputImageType::Pointer
using	GPUInputImageType = itk::GPUImage<InputImagePixelType, InputImageType::ImageDimension>
using	GPUOutputImageType = itk::GPUImage<OutputImagePixelType, OutputImageType::ImageDimension>
using	GPUPyramidPointer = typename GPUPyramidType::Pointer
using	GPUPyramidType = itk::GenericMultiResolutionPyramidImageFilter<GPUInputImageType, GPUOutputImageType, float>
using	InputImagePixelType = typename Superclass1::InputImageType::PixelType
using	ObjectFactoryBasePointer = typename itk::ObjectFactoryBase::Pointer
using	OutputImagePixelType = typename Superclass1::OutputImageType::PixelType
using	Pointer = itk::SmartPointer<Self>
using	Self = OpenCLMovingGenericPyramid
using	Superclass = MovingGenericPyramid<TElastix>
using	Superclass1 = typename MovingGenericPyramid<TElastix>::Superclass1
using	Superclass2 = typename MovingGenericPyramid<TElastix>::Superclass2
Public Types inherited from elastix::MovingGenericPyramid< TElastix >
using	ConstPointer = itk::SmartPointer<const Self>
using	ITKBaseType = typename Superclass2::ITKBaseType
using	Pointer = itk::SmartPointer<Self>
using	Self = MovingGenericPyramid
using	Superclass1
using	Superclass2 = MovingImagePyramidBase<TElastix>
Public Types inherited from itk::GenericMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TPrecisionType >
using	ConstPointer = SmartPointer<const Self>
using	Pointer = SmartPointer<Self>
using	RescaleFactorArrayType = SigmaArrayType
using	RescaleScheduleType = ScheduleType
using	ScalarRealType = typename NumericTraits<PixelType>::ScalarRealType
using	Self = GenericMultiResolutionPyramidImageFilter
using	SigmaArrayType = FixedArray<ScalarRealType, Self::ImageDimension>
using	SmoothingScheduleType = vnl_matrix<ScalarRealType>
using	SpacingType = typename Superclass::InputImageType::SpacingType
using	Superclass = MultiResolutionPyramidImageFilter<TInputImage, TOutputImage>
using	SuperSuperclass = typename Superclass::Superclass
Public Types inherited from elastix::MovingImagePyramidBase< TElastix >
using	ElastixType
using	InputImageType = typename ElastixType::MovingImageType
using	ITKBaseType = itk::MultiResolutionPyramidImageFilter<InputImageType, OutputImageType>
using	OutputImageType = typename ElastixType::MovingImageType
using	RegistrationType
using	ScheduleType = typename ITKBaseType::ScheduleType
using	Self = MovingImagePyramidBase
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	BeforeRegistration () override
	elxClassNameMacro ("OpenCLMovingGenericImagePyramid")
	ITK_DISALLOW_COPY_AND_MOVE (OpenCLMovingGenericPyramid)
	itkOverrideGetNameOfClassMacro (OpenCLMovingGenericPyramid)
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass1::ImageDimension)
virtual void	ReadFromFile ()
Public Member Functions inherited from elastix::MovingGenericPyramid< TElastix >
void	BeforeEachResolution () override
	elxClassNameMacro ("MovingGenericImagePyramid")
	ITK_DISALLOW_COPY_AND_MOVE (MovingGenericPyramid)
	itkOverrideGetNameOfClassMacro (MovingGenericPyramid)
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass1::ImageDimension)
void	SetMovingSchedule () override
Public Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TPrecisionType >
virtual void	ComputeOnlyForCurrentLevelOff ()
virtual void	ComputeOnlyForCurrentLevelOn ()
virtual bool	GetComputeOnlyForCurrentLevel () const
virtual const unsigned int &	GetCurrentLevel ()
const RescaleScheduleType &	GetRescaleSchedule () const
virtual const SmoothingScheduleType &	GetSmoothingSchedule ()
	ITK_DISALLOW_COPY_AND_MOVE (GenericMultiResolutionPyramidImageFilter)
	itkOverrideGetNameOfClassMacro (GenericMultiResolutionPyramidImageFilter)
	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	SetSchedule (const ScheduleType &schedule) override
virtual void	SetSmoothingSchedule (const SmoothingScheduleType &schedule)
virtual void	SetSmoothingScheduleToZero ()
Public Member Functions inherited from elastix::MovingImagePyramidBase< TElastix >
void	BeforeEachResolutionBase () override
void	BeforeRegistrationBase () override
ITKBaseType *	GetAsITKBaseType ()
const ITKBaseType *	GetAsITKBaseType () const
	ITK_DISALLOW_COPY_AND_MOVE (MovingImagePyramidBase)
	itkOverrideGetNameOfClassMacro (MovingImagePyramidBase)
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)
itk::Statistics::MersenneTwisterRandomVariateGenerator &	GetRandomVariateGenerator ()
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 const char *	elxGetClassName () const
const char *	GetComponentLabel () const
	ITK_DISALLOW_COPY_AND_MOVE (BaseComponent)
	itkVirtualGetNameOfClassMacro (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< TInputImage, TOutputImage, TPrecisionType >
static Pointer	New ()
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 Member Functions
void	BeforeGenerateData ()
void	GenerateData () override
	OpenCLMovingGenericPyramid ()
	~OpenCLMovingGenericPyramid () override=default
Protected Member Functions inherited from elastix::MovingGenericPyramid< TElastix >
	MovingGenericPyramid ()=default
	~MovingGenericPyramid () override=default
Protected Member Functions inherited from itk::GenericMultiResolutionPyramidImageFilter< TInputImage, TOutputImage, TPrecisionType >
void	GenerateData () override
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
void	GenerateOutputRequestedRegion (DataObject *output) override
	GenericMultiResolutionPyramidImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
void	ReleaseOutputs ()
	~GenericMultiResolutionPyramidImageFilter () override=default
Protected Member Functions inherited from elastix::MovingImagePyramidBase< TElastix >
	MovingImagePyramidBase ()=default
	~MovingImagePyramidBase () 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
void	RegisterFactories ()
void	ReportToLog ()
void	SwitchingToCPUAndReport (const bool configError)
void	UnregisterFactories ()

Private Attributes
	elxOverrideGetSelfMacro
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< TInputImage, TOutputImage, TPrecisionType >
bool	m_ComputeOnlyForCurrentLevel {}
unsigned int	m_CurrentLevel {}
SmoothingScheduleType	m_SmoothingSchedule {}
bool	m_SmoothingScheduleDefined {}
Protected Attributes inherited from elastix::BaseComponentSE< TElastix >
Configuration::ConstPointer	m_Configuration {}
itk::WeakPointer< TElastix >	m_Elastix {}
RegistrationType *	m_Registration {}

Member Typedef Documentation

◆ ConstPointer

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 59 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUInputImagePointer

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::GPUInputImagePointer = typename GPUInputImageType::Pointer

Definition at line 87 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUInputImageType

template<typename TElastix>

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

GPU Typedefs for GPU image and GPU filter.

Definition at line 86 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUOutputImageType

template<typename TElastix>

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

Definition at line 88 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUPyramidPointer

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::GPUPyramidPointer = typename GPUPyramidType::Pointer

Definition at line 91 of file elxOpenCLMovingGenericPyramid.h.

◆ GPUPyramidType

template<typename TElastix>

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

Definition at line 90 of file elxOpenCLMovingGenericPyramid.h.

◆ InputImagePixelType

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::InputImagePixelType = typename Superclass1::InputImageType::PixelType

Definition at line 79 of file elxOpenCLMovingGenericPyramid.h.

◆ ObjectFactoryBasePointer

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::ObjectFactoryBasePointer = typename itk::ObjectFactoryBase::Pointer

Typedefs for factory.

Definition at line 83 of file elxOpenCLMovingGenericPyramid.h.

◆ OutputImagePixelType

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::OutputImagePixelType = typename Superclass1::OutputImageType::PixelType

Definition at line 80 of file elxOpenCLMovingGenericPyramid.h.

◆ Pointer

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::Pointer = itk::SmartPointer<Self>

Definition at line 58 of file elxOpenCLMovingGenericPyramid.h.

◆ Self

template<typename TElastix>

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

Standard ITK-stuff.

Definition at line 54 of file elxOpenCLMovingGenericPyramid.h.

◆ Superclass

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::Superclass = MovingGenericPyramid<TElastix>

Definition at line 55 of file elxOpenCLMovingGenericPyramid.h.

◆ Superclass1

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::Superclass1 = typename MovingGenericPyramid<TElastix>::Superclass1

Definition at line 56 of file elxOpenCLMovingGenericPyramid.h.

◆ Superclass2

template<typename TElastix>

using elastix::OpenCLMovingGenericPyramid< TElastix >::Superclass2 = typename MovingGenericPyramid<TElastix>::Superclass2

Definition at line 57 of file elxOpenCLMovingGenericPyramid.h.

Constructor & Destructor Documentation

◆ OpenCLMovingGenericPyramid()

template<typename TElastix>

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

protected

The constructor.

◆ ~OpenCLMovingGenericPyramid()

template<typename TElastix>

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

overrideprotecteddefault

The destructor.

Member Function Documentation

◆ BeforeGenerateData()

template<typename TElastix>

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

protected

This method performs all configuration for GPU pyramid.

◆ BeforeRegistration()

template<typename TElastix>

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

overridevirtual

Do some things before registration.

Reimplemented from elastix::BaseComponent.

◆ elxClassNameMacro()

template<typename 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<typename TElastix>

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

overrideprotected

Executes GPU pyramid.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TElastix>

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

◆ itkOverrideGetNameOfClassMacro()

template<typename TElastix>

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

Run-time type information (and related methods).

◆ itkStaticConstMacro()

template<typename TElastix>

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

Get the ImageDimension.

◆ New()

template<typename TElastix>

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

static

Method for creation through the object factory.

◆ ReadFromFile()

template<typename TElastix>

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

virtual

Function to read parameters from a file.

◆ RegisterFactories()

template<typename TElastix>

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

private

Register/Unregister factories.

◆ ReportToLog()

template<typename TElastix>

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

private

Helper method to report to elastix log.

◆ SwitchingToCPUAndReport()

template<typename TElastix>

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

private

Helper method to report switching to CPU mode.

◆ UnregisterFactories()

template<typename TElastix>

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

private

Member Data Documentation

◆ elxOverrideGetSelfMacro

template<typename TElastix>

elastix::OpenCLMovingGenericPyramid< TElastix >::elxOverrideGetSelfMacro

private

Definition at line 116 of file elxOpenCLMovingGenericPyramid.h.

◆ m_ContextCreated

template<typename TElastix>

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_ContextCreated

private

Definition at line 136 of file elxOpenCLMovingGenericPyramid.h.

◆ m_Factories

template<typename TElastix>

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

private

Definition at line 138 of file elxOpenCLMovingGenericPyramid.h.

◆ m_GPUPyramid

template<typename TElastix>

GPUPyramidPointer elastix::OpenCLMovingGenericPyramid< TElastix >::m_GPUPyramid

private

Definition at line 133 of file elxOpenCLMovingGenericPyramid.h.

◆ m_GPUPyramidCreated

template<typename TElastix>

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_GPUPyramidCreated

private

Definition at line 135 of file elxOpenCLMovingGenericPyramid.h.

◆ m_GPUPyramidReady

template<typename TElastix>

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_GPUPyramidReady

private

Definition at line 134 of file elxOpenCLMovingGenericPyramid.h.

◆ m_UseOpenCL

template<typename TElastix>

bool elastix::OpenCLMovingGenericPyramid< TElastix >::m_UseOpenCL

private

Definition at line 137 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

◆ ObjectFactoryBasePointer

◆ OutputImagePixelType

◆ Pointer

◆ Self

◆ Superclass

◆ Superclass1

◆ Superclass2

Constructor & Destructor Documentation

◆ OpenCLMovingGenericPyramid()

◆ ~OpenCLMovingGenericPyramid()

Member Function Documentation

◆ BeforeGenerateData()

◆ BeforeRegistration()

◆ elxClassNameMacro()

◆ GenerateData()

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkOverrideGetNameOfClassMacro()

◆ itkStaticConstMacro()

◆ New()

◆ ReadFromFile()

◆ RegisterFactories()

◆ ReportToLog()

◆ SwitchingToCPUAndReport()

◆ UnregisterFactories()

Member Data Documentation

◆ elxOverrideGetSelfMacro

◆ m_ContextCreated

◆ m_Factories

◆ m_GPUPyramid

◆ m_GPUPyramidCreated

◆ m_GPUPyramidReady

◆ m_UseOpenCL