#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	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

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 Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

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)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
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 Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

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

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
GPUKernelManager::Pointer	m_GPUKernelManager {}

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Attributes
bool	m_GPUEnabled { true }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

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.

◆ DataObjectIdentifierType

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

using itk::ProcessObject::DataObjectIdentifierType = DataObject::DataObjectIdentifierType

Definition at line 162 of file itkProcessObject.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 ( )

overridevirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ 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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< 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

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 *	graft
	)

overrideprotectedvirtual

Graft the specified data object onto this ProcessObject's named output. This is similar to the GraftOutput method except it allows you to specify which output is affected. See the GraftOutput for general usage information.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ 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 * graft )

overrideprotectedvirtual

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to use as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin, Direction) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

      // Setup the mini-pipeline to process the input to this filter
      // The input is not connected to the pipeline.
      auto input = InputImageType::New();
      input->Graft( const_cast< InputImageType * >( this->GetInput() );
      firstFilterInMiniPipeline->SetInput( input );
      // setup the mini-pipeline to calculate the correct regions
      // and write to the appropriate bulk data block
      lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
 
      // execute the mini-pipeline
      lastFilterInMiniPipeline->Update();
 
      // graft the mini-pipeline output back onto this filter's output.
      // this is needed to get the appropriate regions passed back.
      this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

Reimplemented from itk::ImageSource< TOutputImage >.

◆ 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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageToImageFilter< 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:

itkGPUImageToImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectIdentifierType

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ GPUImageToImageFilter()

◆ ~GPUImageToImageFilter()

Member Function Documentation

◆ GenerateData()

◆ GetGPUEnabled()

◆ GetNameOfClass()

◆ GPUEnabledOn()

◆ GPUGenerateData()

◆ GraftOutput() [1/4]

◆ GraftOutput() [2/4]

◆ GraftOutput() [3/4]

◆ GraftOutput() [4/4]

◆ New()

◆ PrintSelf()

◆ SetGPUEnabled()

Member Data Documentation

◆ InputImageDimension

◆ m_GPUEnabled

◆ m_GPUKernelManager

◆ OutputImageDimension