#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
using	ConstPointer = SmartPointer< const Self >

using	CPUSuperclass = TParentImageFilter

using	DeformationScalarType = typename TDisplacementField::PixelType::ValueType

using	DeformationVectorType = typename TDisplacementField::PixelType

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = TDisplacementField

using	FiniteDifferenceFunctionType = typename GPUSuperclass::FiniteDifferenceFunctionType

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImageType = TFixedImage

using	GPUPDEDeformableRegistrationFunctionType = GPUPDEDeformableRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >

using	GPUSuperclass = GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImageType = TMovingImage

using	OutputImageType = typename GPUSuperclass::OutputImageType

using	Pointer = SmartPointer< Self >

using	Self = GPUPDEDeformableRegistrationFilter

using	StandardDeviationsType = FixedArray< double, ImageDimension >

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

using	CPUSuperclass = TParentImageFilter

using	FiniteDifferenceFunctionType = typename GPUSuperclass::FiniteDifferenceFunctionType

using	GPUSuperclass = GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >

using	InputImageType = typename GPUSuperclass::InputImageType

using	OutputImageType = typename GPUSuperclass::OutputImageType

using	PixelType = typename GPUSuperclass::PixelType

using	Pointer = SmartPointer< Self >

using	Self = GPUDenseFiniteDifferenceImageFilter

using	TimeStepType = typename GPUSuperclass::TimeStepType

using	UpdateBufferType = OutputImageType

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

using	CPUSuperclass = TParentImageFilter

enum	FilterStateType

using	FiniteDifferenceFunctionType = typename GPUFiniteDifferenceFunction< TDisplacementField >::DifferenceFunctionType

using	GPUSuperclass = GPUInPlaceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >

using	InputImageType = TDisplacementField

using	InputPixelType = typename TDisplacementField::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = TDisplacementField

using	OutputPixelType = typename TDisplacementField::PixelType

using	OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType

using	PixelType = OutputPixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename FiniteDifferenceFunctionType::RadiusType

using	Self = GPUFiniteDifferenceImageFilter

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

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

using	CPUSuperclass = TParentImageFilter

using	GPUSuperclass = GPUImageToImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TDisplacementField

using	OutputImagePixelType = typename GPUSuperclass::OutputImagePixelType

using	OutputImagePointer = typename GPUSuperclass::OutputImagePointer

using	OutputImageRegionType = typename GPUSuperclass::OutputImageRegionType

using	OutputImageType = typename GPUSuperclass::OutputImageType

using	Pointer = SmartPointer< Self >

using	Self = GPUInPlaceImageFilter

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

using	DataObjectIdentifierType = typename Superclass::DataObjectIdentifierType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TDisplacementField

using	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	Pointer = SmartPointer< Self >

using	Self = GPUImageToImageFilter

using	Superclass = TParentImageFilter

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

DisplacementFieldType *	GetDisplacementField ()

virtual const char *	GetNameOfClass () const

	itkGetOpenCLSourceFromKernelMacro (GPUPDEDeformableRegistrationFilterKernel)

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

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

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

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 (typename itk::GPUTraits< TDisplacementField >::Type *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, typename itk::GPUTraits< TDisplacementField >::Type *output)

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 constexpr unsigned int	ImageDimension = GPUSuperclass::ImageDimension

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

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

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

static constexpr unsigned int	OutputImageDimension

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

static constexpr unsigned int	OutputImageDimension

Protected Member Functions
virtual void	AllocateSmoothingBuffer ()

void	CopyInputToOutput () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

	GPUPDEDeformableRegistrationFilter ()

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

void	Initialize () override

void	InitializeIteration () override

void	PostProcessOutput () override

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

void	SmoothDisplacementField () override

void	SmoothUpdateField () override

	~GPUPDEDeformableRegistrationFilter () override

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

void	ApplyUpdate (const TimeStepType &dt) override

void	CopyInputToOutput () override

UpdateBufferType *	GetUpdateBuffer () override

void	GPUApplyUpdate (const TimeStepType &dt) override

TimeStepType	GPUCalculateChange () override

	GPUDenseFiniteDifferenceImageFilter ()

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

	~GPUDenseFiniteDifferenceImageFilter () override

Protected Member Functions inherited from itk::GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
void	GenerateInputRequestedRegion () override

virtual void	GPUApplyUpdate (const TimeStepType &dt)=0

	GPUFiniteDifferenceImageFilter ()

void	GPUGenerateData () override

bool	Halt () override

void	Initialize () override

void	InitializeIteration () override

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

bool	ThreadedHalt (void *) override

	~GPUFiniteDifferenceImageFilter () override

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

	GPUInPlaceImageFilter ()

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

	~GPUInPlaceImageFilter () override

void	ReleaseInputs () override

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

void	GraftOutput (DataObject *output) override

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

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

	~GPUImageToImageFilter () override

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