#include <itkGPUPDEDeformableRegistrationFilter.h>

Inheritance diagram for itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter >:

Collaboration diagram for itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter >:

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField, typename TParentImageFilter = PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >>
class itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter >

Deformably register two images using a PDE algorithm.

GPUPDEDeformableRegistrationFilter is a base case for filter implementing a PDE deformable algorithm that register two images by computing the deformation field which will map a moving image onto a fixed image.

A deformation field is represented as a image whose pixel type is some vector type with at least N elements, where N is the dimension of the fixed image. The vector type must support element access via operator []. It is assumed that the vector elements behave like floating point scalars.

This class is templated over the fixed image type, moving image type and the deformation Field type.

The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial deformation field maybe set via SetInitialDisplacementField or SetInput. If no initial field is set, a zero field is used as the initial condition.

The output deformation field can be obtained via methods GetOutput or GetDisplacementField.

The PDE algorithm is run for a user defined number of iterations. Typically the PDE algorithm requires period Gaussin smoothing of the deformation field to enforce an elastic-like condition. The amount of smoothing is governed by a set of user defined standard deviations (one for each dimension).

In terms of memory, this filter keeps two internal buffers: one for storing the intermediate updates to the field and one for double-buffering when smoothing the deformation field. Both buffers are the same type and size as the output deformation field.

This class make use of the finite difference solver hierarchy. Update for each iteration is computed using a PDEDeformableRegistrationFunction.

Warning: This filter assumes that the fixed image type, moving image type and deformation field type all have the same number of dimensions.

See Also: PDEDeformableRegistrationFunction.

Definition at line 81 of file itkGPUPDEDeformableRegistrationFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef TParentImageFilter	CPUSuperclass

typedef TDisplacementField::PixelType::ValueType	DeformationScalarType

typedef TDisplacementField::PixelType	DeformationVectorType

typedef DisplacementFieldType::Pointer	DisplacementFieldPointer

typedef TDisplacementField	DisplacementFieldType

typedef GPUSuperclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType

typedef FixedImageType::ConstPointer	FixedImageConstPointer

typedef FixedImageType::Pointer	FixedImagePointer

typedef TFixedImage	FixedImageType

typedef GPUPDEDeformableRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	GPUPDEDeformableRegistrationFunctionType

typedef GPUDenseFiniteDifferenceImageFilter < TDisplacementField, TDisplacementField, TParentImageFilter >	GPUSuperclass

typedef MovingImageType::ConstPointer	MovingImageConstPointer

typedef MovingImageType::Pointer	MovingImagePointer

typedef TMovingImage	MovingImageType

typedef GPUSuperclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef GPUPDEDeformableRegistrationFilter	Self

typedef FixedArray< double, ImageDimension >	StandardDeviationsType

Public Types inherited from itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
typedef SmartPointer< const Self >	ConstPointer

typedef TParentImageFilter	CPUSuperclass

typedef GPUSuperclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType

typedef GPUFiniteDifferenceImageFilter < TDisplacementField, TDisplacementField, TParentImageFilter >	GPUSuperclass

typedef GPUSuperclass::InputImageType	InputImageType

typedef GPUSuperclass::OutputImageType	OutputImageType

typedef GPUSuperclass::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef GPUDenseFiniteDifferenceImageFilter	Self

typedef GPUSuperclass::TimeStepType	TimeStepType

typedef OutputImageType	UpdateBufferType

Public Types inherited from itk::GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
typedef SmartPointer< const Self >	ConstPointer

typedef TParentImageFilter	CPUSuperclass

enum	FilterStateType

typedef GPUFiniteDifferenceFunction < TDisplacementField > ::DifferenceFunctionType	FiniteDifferenceFunctionType

typedef GPUInPlaceImageFilter < TDisplacementField, TDisplacementField, TParentImageFilter >	GPUSuperclass

typedef TDisplacementField	InputImageType

typedef TDisplacementField::PixelType	InputPixelType

typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType

typedef TDisplacementField	OutputImageType

typedef TDisplacementField::PixelType	OutputPixelType

typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType

typedef OutputPixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef FiniteDifferenceFunctionType::RadiusType	RadiusType

typedef GPUFiniteDifferenceImageFilter	Self

typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType

Public Types inherited from itk::GPUInPlaceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
typedef SmartPointer< const Self >	ConstPointer

typedef TParentImageFilter	CPUSuperclass

typedef GPUImageToImageFilter < TDisplacementField, TDisplacementField, TParentImageFilter >	GPUSuperclass

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TDisplacementField	InputImageType

typedef GPUSuperclass::OutputImagePixelType	OutputImagePixelType

typedef GPUSuperclass::OutputImagePointer	OutputImagePointer

typedef GPUSuperclass::OutputImageRegionType	OutputImageRegionType

typedef GPUSuperclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef GPUInPlaceImageFilter	Self

Public Types inherited from itk::GPUImageToImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TDisplacementField	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef GPUImageToImageFilter	Self

typedef TParentImageFilter	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

DisplacementFieldType *	GetDisplacementField ()

const FixedImageType *	GetFixedImage () const

const MovingImageType *	GetMovingImage () const

virtual const char *	GetNameOfClass () const

	itkGetOpenCLSourceFromKernelMacro (GPUPDEDeformableRegistrationFilterKernel)

void	SetFixedImage (const FixedImageType *ptr)

void	SetInitialDisplacementField (const DisplacementFieldType *ptr)

void	SetMovingImage (const MovingImageType *ptr)

Public Member Functions inherited from itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
	itkGetOpenCLSourceFromKernelMacro (GPUDenseFiniteDifferenceImageFilterKernel)

	typedef (Concept::MultiplyOperator< PixelType, double >) OutputTimesDoubleCheck

	typedef (Concept::AdditiveOperators< PixelType >) OutputAdditiveOperatorsCheck

	typedef (Concept::Convertible< typename TDisplacementField::PixelType, PixelType >) InputConvertibleToOutputCheck

Public Member Functions inherited from itk::GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const override

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *differenceFunction) override

virtual void	SetState (FilterStateType _arg)

virtual const FilterStateType &	GetState () const

virtual const TimeProbe &	GetInitTime () const

virtual const TimeProbe &	GetComputeUpdateTime () const

virtual const TimeProbe &	GetApplyUpdateTime () const

virtual const TimeProbe &	GetSmoothFieldTime () const

Public Member Functions inherited from itk::GPUImageToImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
virtual ::itk::LightObject::Pointer	CreateAnother () const

void	GenerateData () override

virtual bool	GetGPUEnabled () const

virtual void	GPUEnabledOff ()

virtual void	GPUEnabledOn ()

virtual void	GraftOutput (DataObject *output) override

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output) override

virtual void	SetGPUEnabled (bool _arg)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::GPUImageToImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = GPUSuperclass::ImageDimension

Static Public Attributes inherited from itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
static const unsigned int	ImageDimension

Static Public Attributes inherited from itk::GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
static const unsigned int	ImageDimension

Static Public Attributes inherited from itk::GPUInPlaceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::GPUImageToImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Protected Member Functions
virtual void	AllocateSmoothingBuffer ()

virtual void	CopyInputToOutput () override

virtual void	GenerateInputRequestedRegion () override

virtual void	GenerateOutputInformation () override

	GPUPDEDeformableRegistrationFilter ()

virtual void	GPUSmoothVectorField (DisplacementFieldPointer field, typename GPUDataManager::Pointer GPUSmoothingKernels[], int GPUSmoothingKernelSizes[])

virtual void	Initialize () override

virtual void	InitializeIteration () override

virtual void	PostProcessOutput () override

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

virtual void	SmoothDisplacementField () override

virtual void	SmoothUpdateField () override

	~GPUPDEDeformableRegistrationFilter ()

Protected Member Functions inherited from itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
virtual void	AllocateUpdateBuffer () override

virtual void	ApplyUpdate (const TimeStepType &dt) override

virtual UpdateBufferType *	GetUpdateBuffer () override

virtual void	GPUApplyUpdate (const TimeStepType &dt) override

virtual TimeStepType	GPUCalculateChange () override

	GPUDenseFiniteDifferenceImageFilter ()

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

	~GPUDenseFiniteDifferenceImageFilter ()

Protected Member Functions inherited from itk::GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
virtual void	GPUApplyUpdate (const TimeStepType &dt)=0

	GPUFiniteDifferenceImageFilter ()

virtual void	GPUGenerateData () override

virtual bool	Halt () override

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

virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const override

virtual bool	ThreadedHalt (void *) override

	~GPUFiniteDifferenceImageFilter ()

Protected Member Functions inherited from itk::GPUInPlaceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
virtual void	AllocateOutputs () override

	GPUInPlaceImageFilter ()

virtual void	ReleaseInputs () override

	~GPUInPlaceImageFilter ()

Protected Member Functions inherited from itk::GPUImageToImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
	GPUImageToImageFilter ()

	~GPUImageToImageFilter ()

Private Member Functions
	GPUPDEDeformableRegistrationFilter (const Self &) ITK_DELETE_FUNCTION

void	operator= (const Self &) ITK_DELETE_FUNCTION

Additional Inherited Members
Protected Attributes inherited from itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
int	m_ApplyUpdateGPUKernelHandle

Protected Attributes inherited from itk::GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
TimeProbe	m_ApplyUpdateTime

TimeProbe	m_ComputeUpdateTime

TimeProbe	m_InitTime

bool	m_ManualReinitialization

double	m_MaximumRMSError

double	m_RMSChange

TimeProbe	m_SmoothFieldTime

Protected Attributes inherited from itk::GPUImageToImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
GPUKernelManager::Pointer	m_GPUKernelManager