#include <itkGPUDenseFiniteDifferenceImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = DenseFiniteDifferenceImageFilter<TInputImage, TOutputImage>>
class itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >

This is the GPU version of DenseFiniteDifferenceImageFilter class. Currently only single-threaded, single GPU version is implemented. See documentation for FiniteDifferenceImageFilter for an overview of the iterative finite difference algorithm:

: \(u_{\mathbf{i}}^{n+1}=u^n_{\mathbf{i}}+\Delta u^n_{\mathbf{i}}\Delta t\)

: This class defines an update buffer for \( \Delta \) and the methods GPUCalculateChange() and GPUApplyUpdate(), which are GPU version of CalculateChange() and ApplyUpdate().

Use m_UpdateBuffer defined in CPU superclass (DenseFiniteDifferenceImageFilter).

How to use this class: This filter can be used as a base class for GPU implementation of DenseFiniteDifferenceImageFilter.

Definition at line 55 of file itkGPUDenseFiniteDifferenceImageFilter.h.

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

Collaboration diagram for itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CPUSuperclass = TParentImageFilter

using	FiniteDifferenceFunctionType = typename GPUSuperclass::FiniteDifferenceFunctionType

using	GPUSuperclass = GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, 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< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
using	ConstPointer = SmartPointer< const Self >

using	CPUSuperclass = DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >

using	FiniteDifferenceFunctionType = typename GPUFiniteDifferenceFunction< TOutputImage >::DifferenceFunctionType

using	GPUSuperclass = GPUInPlaceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::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< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
using	ConstPointer = SmartPointer< const Self >

using	CPUSuperclass = DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >

using	GPUSuperclass = GPUImageToImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

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< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
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 = DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = DenseFiniteDifferenceImageFilter

using	Superclass = FiniteDifferenceImageFilter< TInputImage, TOutputImage >

using	UpdateBufferType = OutputImageType

Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	FiniteDifferenceFunctionType = FiniteDifferenceFunction< TOutputImage >

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::PixelType

using	OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType

using	PixelType = OutputPixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename FiniteDifferenceFunctionType::RadiusType

using	Self = FiniteDifferenceImageFilter

using	Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

Public Types inherited from itk::InPlaceImageFilter< 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 = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

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
const char *	GetNameOfClass () const override

	itkGetOpenCLSourceFromKernelMacro (GPUDenseFiniteDifferenceImageFilterKernel)

Public Member Functions inherited from itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const override

const char *	GetNameOfClass () const override

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

void	SetDifferenceFunction (FiniteDifferenceFunctionType *differenceFunction) override

virtual void	SetState (GPUFiniteDifferenceFilterEnum _arg)

virtual const GPUFiniteDifferenceFilterEnum &	GetState () const

virtual const TimeProbe &	GetInitTime () const

virtual const TimeProbe &	GetComputeUpdateTime () const

virtual const TimeProbe &	GetApplyUpdateTime () const

virtual const TimeProbe &	GetSmoothFieldTime () const

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
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)

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const

virtual const IdentifierType &	GetElapsedIterations () const

virtual bool	GetIsInitialized ()

const char *	GetNameOfClass () const override

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

virtual void	SetIsInitialized (bool _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)

virtual const IdentifierType &	GetNumberOfIterations () const

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual const bool &	GetUseImageSpacing () const

virtual void	SetMaximumRMSError (double _arg)

virtual const double &	GetMaximumRMSError () const

virtual void	SetRMSChange (double _arg)

virtual const double &	GetRMSChange () const

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization () const

virtual void	ManualReinitializationOn ()

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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

Static Public Attributes inherited from itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

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

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

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

static constexpr unsigned int	OutputImageDimension

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
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=default

Protected Member Functions inherited from itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
void	AllocateUpdateBuffer () override=0

void	CopyInputToOutput () override=0

void	GenerateInputRequestedRegion () override

virtual void	GPUApplyUpdate (const TimeStepType &dt)=0

virtual TimeStepType	GPUCalculateChange ()=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

TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const override

bool	ThreadedHalt (void *) override

	~GPUFiniteDifferenceImageFilter () override

Protected Member Functions inherited from itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
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< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
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::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

TimeStepType	CalculateChange () override

void	CopyInputToOutput () override

	DenseFiniteDifferenceImageFilter ()

virtual UpdateBufferType *	GetUpdateBuffer ()

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

virtual void	ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)

virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)

	~DenseFiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual void	AllocateUpdateBuffer ()=0

virtual void	ApplyUpdate (const TimeStepType &dt)=0

virtual TimeStepType	CalculateChange ()=0

virtual void	CopyInputToOutput ()=0

	FiniteDifferenceImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual void	Initialize ()

virtual void	InitializeIteration ()

virtual void	PostProcessOutput ()

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

virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const

virtual void	SetElapsedIterations (IdentifierType _arg)

virtual bool	ThreadedHalt (void *)

	~FiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

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
int	m_ApplyUpdateGPUKernelHandle {}

Protected Attributes inherited from itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
TimeProbe	m_ApplyUpdateTime

TimeProbe	m_ComputeUpdateTime

TimeProbe	m_InitTime

TimeProbe	m_SmoothFieldTime

Protected Attributes inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
GPUKernelManager::Pointer	m_GPUKernelManager

Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
IdentifierType	m_ElapsedIterations {}

bool	m_IsInitialized {}

bool	m_ManualReinitialization {}

double	m_MaximumRMSError {}

IdentifierType	m_NumberOfIterations {}

double	m_RMSChange {}

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 {}

Additional Inherited Members
Static Public Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >
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 ()

Protected Types inherited from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >
using	ThreadRegionType = typename UpdateBufferType::RegionType

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 = DenseFiniteDifferenceImageFilter<TInputImage, TOutputImage>>

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ConstPointer = SmartPointer<const Self>

Definition at line 66 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ CPUSuperclass

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::CPUSuperclass = TParentImageFilter

Definition at line 64 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionType

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::FiniteDifferenceFunctionType = typename GPUSuperclass::FiniteDifferenceFunctionType

Definition at line 74 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ GPUSuperclass

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUSuperclass = GPUFiniteDifferenceImageFilter<TInputImage, TOutputImage, TParentImageFilter>

Definition at line 63 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ InputImageType

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageType = typename GPUSuperclass::InputImageType

Convenient type alias

Definition at line 72 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ OutputImageType

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImageType = typename GPUSuperclass::OutputImageType

Definition at line 73 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ PixelType

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::PixelType = typename GPUSuperclass::PixelType

The pixel type of the output image will be used in computations. Inherited from the superclass.

Definition at line 82 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ Pointer

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Pointer = SmartPointer<Self>

Definition at line 65 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ Self

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Self = GPUDenseFiniteDifferenceImageFilter

Standard class type aliases

Definition at line 62 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ TimeStepType

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::TimeStepType = typename GPUSuperclass::TimeStepType

The value type of a time step. Inherited from the superclass.

Definition at line 85 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ UpdateBufferType

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

using itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::UpdateBufferType = OutputImageType

The container type for the update buffer.

Definition at line 88 of file itkGPUDenseFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

◆ GPUDenseFiniteDifferenceImageFilter()

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

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

protected

◆ ~GPUDenseFiniteDifferenceImageFilter()

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

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

overrideprotecteddefault

Member Function Documentation

◆ AllocateUpdateBuffer()

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

void itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::AllocateUpdateBuffer ( )

overrideprotectedvirtual

This method allocates storage in m_UpdateBuffer. It is called from Superclass::GenerateData().

Implements itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >.

◆ ApplyUpdate()

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

void itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ApplyUpdate ( const TimeStepType & dt )

overrideprotectedvirtual

This method applies changes from the m_UpdateBuffer to the output using the GPU. "dt" is the time step to use for the update of each pixel.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ CopyInputToOutput()

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

void itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::CopyInputToOutput ( )

overrideprotectedvirtual

A simple method to copy the data from the input to the output. ( Supports "read-only" image adaptors in the case where the input image type converts to a different output image type. )

Implements itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >.

Reimplemented in itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > >.

◆ GetNameOfClass()

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

const char * itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GPUAnisotropicDiffusionImageFilter< TInputImage, TOutputImage, GradientAnisotropicDiffusionImageFilter< TInputImage, TOutputImage > >, and itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > >.

◆ GetUpdateBuffer()

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

UpdateBufferType * itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetUpdateBuffer ( )

inlineoverrideprotectedvirtual

Method to allow subclasses to get direct access to the update buffer

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 129 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ GPUApplyUpdate()

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

void itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUApplyUpdate ( const TimeStepType & dt )

overrideprotectedvirtual

This method is defined by a subclass to apply changes to the output from an update buffer and a time step value "dt".

Parameters

dt	Time step value.

Implements itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >.

◆ GPUCalculateChange()

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

TimeStepType itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUCalculateChange ( )

overrideprotectedvirtual

This method populates an update buffer with changes for each pixel in the output using the GPU. Returns value is a time step to be used for the update.

Implements itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage > >.

◆ itkGetOpenCLSourceFromKernelMacro()

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

itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::itkGetOpenCLSourceFromKernelMacro ( GPUDenseFiniteDifferenceImageFilterKernel )

Get OpenCL Kernel source as a string, creates a GetOpenCLSource method

◆ PrintSelf()

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

void itk::GPUDenseFiniteDifferenceImageFilter< 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::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > >.

Member Data Documentation

◆ ImageDimension

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

constexpr unsigned int itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ImageDimension = GPUSuperclass::ImageDimension

staticconstexpr

Dimensionality of input and output data is assumed to be the same. It is inherited from the superclass.

Definition at line 78 of file itkGPUDenseFiniteDifferenceImageFilter.h.

◆ m_ApplyUpdateGPUKernelHandle

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

int itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_ApplyUpdateGPUKernelHandle {}

protected

Definition at line 140 of file itkGPUDenseFiniteDifferenceImageFilter.h.

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

itkGPUDenseFiniteDifferenceImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CPUSuperclass

◆ FiniteDifferenceFunctionType

◆ GPUSuperclass

◆ InputImageType

◆ OutputImageType

◆ PixelType

◆ Pointer

◆ Self

◆ TimeStepType

◆ UpdateBufferType

Constructor & Destructor Documentation

◆ GPUDenseFiniteDifferenceImageFilter()

◆ ~GPUDenseFiniteDifferenceImageFilter()

Member Function Documentation

◆ AllocateUpdateBuffer()

◆ ApplyUpdate()

◆ CopyInputToOutput()

◆ GetNameOfClass()

◆ GetUpdateBuffer()

◆ GPUApplyUpdate()

◆ GPUCalculateChange()

◆ itkGetOpenCLSourceFromKernelMacro()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension

◆ m_ApplyUpdateGPUKernelHandle