ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter > Class Template Reference
Group Core » Module ITKGPUCommon

#include <itkGPUImageToImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
class itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >

class to abstract the behaviour of the GPU filters.

GPUImageToImageFilter is the GPU version of ImageToImageFilter. This class can accept both CPU and GPU image as input and output, and apply filter accordingly. If GPU is available for use, then GPUGenerateData() is called. Otherwise, GenerateData() in the parent class (i.e., ImageToImageFilter) will be called.

Definition at line 41 of file itkGPUImageToImageFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = GPUImageToImageFilter
 
using Superclass = TParentImageFilter
 

Public Member Functions

void GenerateData () override
 
virtual bool GetGPUEnabled () const
 
const char * GetNameOfClass () const override
 
virtual void GPUEnabledOn ()
 
virtual void GraftOutput (const DataObjectIdentifierType &key, typename itk::GPUTraits< TOutputImage >::Type *output)
 
virtual void GraftOutput (typename itk::GPUTraits< TOutputImage >::Type *output)
 
virtual void SetGPUEnabled (bool _arg)
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

virtual void GPUGenerateData ()
 
 GPUImageToImageFilter ()
 
void GraftOutput (const DataObjectIdentifierType &key, DataObject *output) override
 
void GraftOutput (DataObject *output) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GPUImageToImageFilter () override
 

Protected Attributes

GPUKernelManager::Pointer m_GPUKernelManager {}
 

Private Attributes

bool m_GPUEnabled { true }
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkGPUImageToImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 65 of file itkGPUImageToImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 67 of file itkGPUImageToImageFilter.h.

◆ InputImagePointer

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImagePointer = typename InputImageType::Pointer

Definition at line 64 of file itkGPUImageToImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 66 of file itkGPUImageToImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 63 of file itkGPUImageToImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Pointer = SmartPointer<Self>

Definition at line 49 of file itkGPUImageToImageFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Self = GPUImageToImageFilter

Standard class type aliases.

Definition at line 47 of file itkGPUImageToImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
using itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Superclass = TParentImageFilter

Definition at line 48 of file itkGPUImageToImageFilter.h.

Constructor & Destructor Documentation

◆ GPUImageToImageFilter()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUImageToImageFilter ( )
protected

◆ ~GPUImageToImageFilter()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::~GPUImageToImageFilter ( )
overrideprotected

Member Function Documentation

◆ GenerateData()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GenerateData ( )
override

◆ GetGPUEnabled()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
virtual bool itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetGPUEnabled ( ) const
virtual

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
const char* itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetNameOfClass ( ) const
override
See also
LightObject::GetNameOfClass()

Reimplemented in itk::GPUBoxImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUCast< TInputImage::PixelType, TOutputImage::PixelType >, CastImageFilter< TInputImage, TOutputImage > >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUBinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType >, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >.

◆ GPUEnabledOn()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
virtual void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUEnabledOn ( )
virtual

◆ GPUGenerateData()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
virtual void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUGenerateData ( )
inlineprotectedvirtual

Reimplemented in itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >, itk::GPUFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >, itk::GPUNeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType, TParentImageFilter >, itk::GPUBinaryThresholdImageFilter< TInputImage, TOutputImage >, itk::GPUCastImageFilter< TInputImage, TOutputImage >, itk::GPUDiscreteGaussianImageFilter< TInputImage, TOutputImage >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction, TParentImageFilter >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUCast< TInputImage::PixelType, TOutputImage::PixelType >, CastImageFilter< TInputImage, TOutputImage > >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUBinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType >, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUMeanImageFilter< TInputImage, TOutputImage >.

Definition at line 97 of file itkGPUImageToImageFilter.h.

◆ GraftOutput() [1/4]

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GraftOutput ( const DataObjectIdentifierType &  key,
DataObject *  output 
)
overrideprotected

◆ GraftOutput() [2/4]

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
virtual void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GraftOutput ( const DataObjectIdentifierType &  key,
typename itk::GPUTraits< TOutputImage >::Type *  output 
)
virtual

◆ GraftOutput() [3/4]

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GraftOutput ( DataObject *  output)
overrideprotected

◆ GraftOutput() [4/4]

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
virtual void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GraftOutput ( typename itk::GPUTraits< TOutputImage >::Type *  output)
virtual

◆ New()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
static Pointer itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::New ( )
static

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

Reimplemented in itk::GPUBoxImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >, itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, CastImageFilter< TInputImage, TOutputImage > >.

◆ SetGPUEnabled()

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
virtual void itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::SetGPUEnabled ( bool  _arg)
virtual

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
constexpr unsigned int itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension constants

Definition at line 70 of file itkGPUImageToImageFilter.h.

◆ m_GPUEnabled

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
bool itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_GPUEnabled { true }
private

Definition at line 108 of file itkGPUImageToImageFilter.h.

◆ m_GPUKernelManager

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
GPUKernelManager::Pointer itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_GPUKernelManager {}
protected

Definition at line 101 of file itkGPUImageToImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = ImageToImageFilter<TInputImage, TOutputImage>>
constexpr unsigned int itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 71 of file itkGPUImageToImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16