ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter > Class Template Reference

#include <itkGPUInPlaceImageFilter.h>

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

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).

Definition at line 38 of file itkGPUInPlaceImageFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef GPUInPlaceImageFilter Self
 
- Public Types inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >
typedef SmartPointer< const SelfConstPointer
 
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 SmartPointer< SelfPointer
 
typedef GPUImageToImageFilter Self
 
typedef TParentImageFilter Superclass
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, 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 Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

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

Private Member Functions

 GPUInPlaceImageFilter (const Self &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >
static Pointer New ()
 
- Protected Attributes inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >
GPUKernelManager::Pointer m_GPUKernelManager
 

Member Typedef Documentation

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef SmartPointer< const Self > itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ConstPointer

Definition at line 46 of file itkGPUInPlaceImageFilter.h.

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

Definition at line 44 of file itkGPUInPlaceImageFilter.h.

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 43 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef InputImageType::ConstPointer itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageConstPointer

Definition at line 65 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef InputImageType::PixelType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImagePixelType

Definition at line 67 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef InputImageType::Pointer itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImagePointer

Definition at line 64 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef InputImageType::RegionType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageRegionType

Definition at line 66 of file itkGPUInPlaceImageFilter.h.

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 63 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef GPUSuperclass::OutputImagePixelType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImagePixelType

Definition at line 55 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef GPUSuperclass::OutputImagePointer itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImagePointer

Definition at line 53 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef GPUSuperclass::OutputImageRegionType itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImageRegionType

Definition at line 54 of file itkGPUInPlaceImageFilter.h.

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 49 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
typedef SmartPointer< Self > itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Pointer

Definition at line 45 of file itkGPUInPlaceImageFilter.h.

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 42 of file itkGPUInPlaceImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUInPlaceImageFilter ( )
protected
template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::~GPUInPlaceImageFilter ( )
protected
template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUInPlaceImageFilter ( const Self )
private

Member Function Documentation

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
virtual void itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::AllocateOutputs ( )
overrideprotectedvirtual

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().

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
virtual const char* itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetNameOfClass ( ) const
virtual
template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
void itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::operator= ( const Self )
private
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
overrideprotectedvirtual
template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
virtual void itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ReleaseInputs ( )
overrideprotectedvirtual

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

Member Data Documentation

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
const unsigned int itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Definition at line 58 of file itkGPUInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage, typename TParentImageFilter = InPlaceImageFilter< TInputImage, TOutputImage >>
const unsigned int itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension constants

Definition at line 59 of file itkGPUInPlaceImageFilter.h.


The documentation for this class was generated from the following file: