itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter > Class Template Reference

#include <itkGPUInPlaceImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
class itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >

Base class for GPU filters that take an image as input and overwrite that image as the output.

This class is the base class for GPU inplace filter. The template parameter for parent class type must be InPlaceImageFilter type so that the GPU superclass of this class can be correctly defined (NOTE: TParentImageFilter::Superclass is used to define GPUImageToImageFilter class).

Note

This file was taken from ITK 4.1.0. It was modified by Denis P. Shamonin and Marius Staring. Division of Image Processing, Department of Radiology, Leiden, The Netherlands. Added functionality is described in the Insight Journal paper: http://hdl.handle.net/10380/3393

Definition at line 61 of file itkGPUInPlaceImageFilter.h.

Inheritance diagram for itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TParentImageFilter	CPUSuperclass
typedef GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >	GPUSuperclass
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	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< TInputImage, TInputImage, InPlaceImageFilter< TInputImage, TInputImage > >
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 TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TInputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef GPUImageToImageFilter	Self
typedef InPlaceImageFilter< TInputImage, TInputImage >	Superclass

Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
Public Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TInputImage, InPlaceImageFilter< TInputImage, TInputImage > >
virtual const char *	GetClassName () const
virtual bool	GetGPUEnabled () const
virtual void	GPUEnabledOff ()
virtual void	GPUEnabledOn ()
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftOutput (DataObject *graft)
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void	SetGPUEnabled (bool _arg)
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

Protected Member Functions
virtual void	AllocateOutputs ()
	GPUInPlaceImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ReleaseInputs ()
	~GPUInPlaceImageFilter ()
Protected Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TInputImage, InPlaceImageFilter< TInputImage, TInputImage > >
virtual void	GenerateData ()
virtual void	GPUGenerateData ()
	GPUImageToImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	~GPUImageToImageFilter ()

Private Member Functions
	GPUInPlaceImageFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Static Public Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TInputImage, InPlaceImageFilter< TInputImage, TInputImage > >
static Pointer	New ()
Protected Attributes inherited from itk::GPUImageToImageFilter< TInputImage, TInputImage, InPlaceImageFilter< TInputImage, TInputImage > >
OpenCLKernelManager::Pointer	m_GPUKernelManager

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef SmartPointer< const Self > itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ConstPointer

Definition at line 71 of file itkGPUInPlaceImageFilter.h.

CPUSuperclass

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef TParentImageFilter itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::CPUSuperclass

Definition at line 69 of file itkGPUInPlaceImageFilter.h.

GPUSuperclass

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter > itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUSuperclass

Definition at line 68 of file itkGPUInPlaceImageFilter.h.

InputImageConstPointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef InputImageType::ConstPointer itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageConstPointer

Definition at line 89 of file itkGPUInPlaceImageFilter.h.

InputImagePixelType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef InputImageType::PixelType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImagePixelType

Definition at line 91 of file itkGPUInPlaceImageFilter.h.

InputImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef InputImageType::Pointer itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImagePointer

Definition at line 88 of file itkGPUInPlaceImageFilter.h.

InputImageRegionType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef InputImageType::RegionType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageRegionType

Definition at line 90 of file itkGPUInPlaceImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef TInputImage itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageType

Some convenient typedefs.

Definition at line 87 of file itkGPUInPlaceImageFilter.h.

OutputImagePixelType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef GPUSuperclass::OutputImagePixelType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImagePixelType

Definition at line 80 of file itkGPUInPlaceImageFilter.h.

OutputImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef GPUSuperclass::OutputImagePointer itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImagePointer

Definition at line 78 of file itkGPUInPlaceImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef GPUSuperclass::OutputImageRegionType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImageRegionType

Definition at line 79 of file itkGPUInPlaceImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef GPUSuperclass::OutputImageType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImageType

Superclass typedefs.

Definition at line 77 of file itkGPUInPlaceImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef SmartPointer< Self > itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Pointer

Definition at line 70 of file itkGPUInPlaceImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

typedef GPUInPlaceImageFilter itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Self

Standard class typedefs.

Definition at line 67 of file itkGPUInPlaceImageFilter.h.

Constructor & Destructor Documentation

GPUInPlaceImageFilter() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUInPlaceImageFilter ( )

inlineprotected

Definition at line 95 of file itkGPUInPlaceImageFilter.h.

~GPUInPlaceImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::~GPUInPlaceImageFilter ( )

inlineprotected

Definition at line 96 of file itkGPUInPlaceImageFilter.h.

GPUInPlaceImageFilter() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUInPlaceImageFilter ( const Self &  )

private

Member Function Documentation

AllocateOutputs()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

virtual void itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::AllocateOutputs ( )

protectedvirtual

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceImageFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

GetClassName()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

virtual const char * itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::GPUImageToImageFilter< TInputImage, TInputImage, InPlaceImageFilter< TInputImage, TInputImage > >.

Reimplemented in itk::GPUCastImageFilter< TInputImage, TOutputImage >, itk::GPURecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction, TParentImageFilter >, and itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUCast< TInputImage::PixelType, TOutputImage::PixelType >, CastImageFilter< TInputImage, TOutputImage > >.

itkStaticConstMacro() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::itkStaticConstMacro	(	InputImageDimension	,
		unsigned int	,
		TInputImage::ImageDimension
	)

ImageDimension constants

itkStaticConstMacro() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::itkStaticConstMacro	(	OutputImageDimension	,
		unsigned int	,
		TOutputImage::ImageDimension
	)

operator=()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

void itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::operator= ( const Self &  )

private

PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

virtual void itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Reimplemented from itk::GPUImageToImageFilter< TInputImage, TInputImage, InPlaceImageFilter< TInputImage, TInputImage > >.

Reimplemented in itk::GPURecursiveGaussianImageFilter< TInputImage, TOutputImage >.

ReleaseInputs()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>

virtual void itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ReleaseInputs ( )

protectedvirtual

InPlaceImageFilter may transfer ownership of the input bulk data to the output object. Once the output object owns the bulk data (done in AllocateOutputs()), the input object must release its hold on the bulk data. ProcessObject::ReleaseInputs() only releases the input bulk data when the user has set the ReleaseDataFlag. InPlaceImageFilter::ReleaseInputs() also releases the input that it has overwritten.

See also

ProcessObject::ReleaseInputs()