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

#include <itkGPUFiniteDifferenceImageFilter.h>

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

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

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TParentImageFilter = FiniteDifferenceImageFilter< TInputImage, TOutputImage >>
class itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >

Base class for GPU Finite Difference Image Filters.

See Also

GPUDenseFiniteDifferenceImageFilter

Definition at line 37 of file itkGPUFiniteDifferenceImageFilter.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	CPUSuperclass = TParentImageFilter
enum	FilterStateType {   UNINITIALIZED = 0,   INITIALIZED = 1 }
using	FiniteDifferenceFunctionType = typename GPUFiniteDifferenceFunction< TOutputImage >::DifferenceFunctionType
using	GPUSuperclass = GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >
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, TParentImageFilter >
using	ConstPointer = SmartPointer< const Self >
using	CPUSuperclass = TParentImageFilter
using	GPUSuperclass = GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >
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, TParentImageFilter >
using	ConstPointer = SmartPointer< const Self >
using	DataObjectIdentifierType = typename Superclass::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	OutputImagePixelType = typename Superclass::OutputImagePixelType
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
using	Pointer = SmartPointer< Self >
using	Self = GPUImageToImageFilter
using	Superclass = TParentImageFilter

Public Member Functions
const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const override
virtual const char *	GetNameOfClass () const
void	SetStateToInitialized ()
void	SetStateToUninitialized ()
void	SetDifferenceFunction (FiniteDifferenceFunctionType *differenceFunction) override
virtual void	SetState (FilterStateType _arg)
virtual const FilterStateType &	GetState () const
virtual const TimeProbe &	GetInitTime () const
virtual const TimeProbe &	GetComputeUpdateTime () const
virtual const TimeProbe &	GetApplyUpdateTime () const
virtual const TimeProbe &	GetSmoothFieldTime () 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 (typename itk::GPUTraits< TOutputImage >::Type *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, typename itk::GPUTraits< TOutputImage >::Type *output)
virtual void	SetGPUEnabled (bool _arg)

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

Protected Member Functions
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
virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const override
bool	ThreadedHalt (void *) override
	~GPUFiniteDifferenceImageFilter () override
Protected Member Functions inherited from itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >
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, TParentImageFilter >
	GPUImageToImageFilter ()
void	GraftOutput (DataObject *output) override
void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output) override
void	PrintSelf (std::ostream &os, Indent indent) const override
	~GPUImageToImageFilter () override

Protected Attributes
TimeProbe	m_ApplyUpdateTime
TimeProbe	m_ComputeUpdateTime
TimeProbe	m_InitTime
bool	m_ManualReinitialization
double	m_MaximumRMSError
double	m_RMSChange
TimeProbe	m_SmoothFieldTime
Protected Attributes inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >
GPUKernelManager::Pointer	m_GPUKernelManager

Private Member Functions
void	InitializeFunctionCoefficients ()

Private Attributes
FiniteDifferenceFunctionType::Pointer	m_DifferenceFunction
FilterStateType	m_State
bool	m_UseImageSpacing

Additional Inherited Members
Static Public Member Functions inherited from itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >
static Pointer	New ()

Member Typedef Documentation

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

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

Definition at line 48 of file itkGPUFiniteDifferenceImageFilter.h.

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

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

Definition at line 46 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::FiniteDifferenceFunctionType = typename GPUFiniteDifferenceFunction< TOutputImage >::DifferenceFunctionType

The value type of the time step. This is distinct from PixelType because PixelType may often be a vector value, while the TimeStep is a scalar value.

Definition at line 72 of file itkGPUFiniteDifferenceImageFilter.h.

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

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

Definition at line 45 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputImageType = TInputImage

Input and output image types.

Definition at line 54 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputPixelType = typename TInputImage::PixelType

Definition at line 62 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

Definition at line 67 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

Definition at line 75 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputImageType = TOutputImage

Definition at line 55 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputPixelType = typename TOutputImage::PixelType

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

Definition at line 61 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType

Extract value type in case the pixel is of vector type

Definition at line 66 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::PixelType = OutputPixelType

Definition at line 63 of file itkGPUFiniteDifferenceImageFilter.h.

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

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

Definition at line 47 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::RadiusType = typename FiniteDifferenceFunctionType::RadiusType

Definition at line 74 of file itkGPUFiniteDifferenceImageFilter.h.

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

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

Standard class type aliases.

Definition at line 44 of file itkGPUFiniteDifferenceImageFilter.h.

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

using itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

Definition at line 73 of file itkGPUFiniteDifferenceImageFilter.h.

Member Enumeration Documentation

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

enum itk::GPUFiniteDifferenceImageFilter::FilterStateType

Enumerator
UNINITIALIZED
INITIALIZED

Definition at line 99 of file itkGPUFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

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

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

protected

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

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

overrideprotected

Member Function Documentation

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

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

overrideprotectedpure virtual

This method allocates a temporary update container in the subclass.

Implemented in itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >, and itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >.

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

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

overrideprotectedpure virtual

This method can be defined in subclasses as needed to copy the input to the output. See DenseFiniteDifferenceImageFilter for an implementation.

Implemented in itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter >, itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >, and itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GenerateInputRequestedRegion ( )

overrideprotected

FiniteDifferenceImageFilter needs a larger input requested region than the output requested region. As such, we need to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

The filter will ask for a padded region to perform its neighborhood calculations. If no such region is available, the boundaries will be handled as described in the FiniteDifferenceFunction defined by the subclass.

See Also

ProcessObject::GenerateInputRequestedRegion()

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

virtual const TimeProbe& itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetApplyUpdateTime ( ) const

virtual

Methods to get timers

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

virtual const TimeProbe& itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetComputeUpdateTime ( ) const

virtual

Methods to get timers

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

const FiniteDifferenceFunctionType::Pointer& itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetDifferenceFunction ( ) const

inlineoverride

This method returns a pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns

A FiniteDifferenceObject pointer.

Definition at line 80 of file itkGPUFiniteDifferenceImageFilter.h.

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

virtual const TimeProbe& itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetInitTime ( ) const

virtual

Methods to get timers

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

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

virtual

Run-time type information (and related methods)

Reimplemented from itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >.

Reimplemented in itk::GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter >, itk::GPUDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter >, itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >, itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >, itk::GPUGradientAnisotropicDiffusionImageFilter< TInputImage, TOutputImage, TParentImageFilter >, and itk::GPUAnisotropicDiffusionImageFilter< TInputImage, TOutputImage, TParentImageFilter >.

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

virtual const TimeProbe& itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetSmoothFieldTime ( ) const

virtual

Methods to get timers

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

virtual const FilterStateType& itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GetState ( ) const

virtual

Set/Get the state of the filter.

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

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

protectedpure virtual

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.

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

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

protectedpure virtual

This method is defined by a subclass to populate an update buffer with changes for the pixels in the output. It returns a time step value to be used for the update.

Returns

A time step to use in updating the output with the changes calculated from this method.

Implemented in itk::GPUDenseFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >, and itk::GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUGenerateData ( )

overrideprotectedvirtual

This is the default, high-level algorithm for calculating finite difference solutions. It calls virtual methods in its subclasses to implement the major steps of the algorithm.

Reimplemented from itk::GPUImageToImageFilter< TInputImage, TOutputImage, TParentImageFilter >.

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

bool itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Halt ( )

overrideprotected

This method returns true when the current iterative solution of the equation has met the criteria to stop solving. Defined by a subclass.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::Initialize ( )

inlineoverrideprotected

This method is optionally defined by a subclass and is called before the loop of iterations of calculate_change & upate. It does the global initialization, i.e. in the SparseFieldLevelSetImageFilter, initialize the list of layers.

Definition at line 200 of file itkGPUFiniteDifferenceImageFilter.h.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InitializeFunctionCoefficients ( )

private

Initialize the values of the Function coefficients. This function will also take care of checking whether the image spacing should be taken into account or not.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::InitializeIteration ( )

inlineoverrideprotected

This method is optionally defined by a subclass and is called immediately prior to each iterative CalculateChange-ApplyUpdate cycle. It can be used to set global variables needed for the next iteration (ie. average gradient magnitude of the image in anisotropic diffusion functions), or otherwise prepare for the next iteration.

Definition at line 209 of file itkGPUFiniteDifferenceImageFilter.h.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::PostProcessOutput ( )

inlineoverrideprotected

This method is called after the solution has been generated to allow subclasses to apply some further processing to the output.

Definition at line 231 of file itkGPUFiniteDifferenceImageFilter.h.

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

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

overrideprotected

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

virtual TimeStepType itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ResolveTimeStep ( const std::vector< TimeStepType > &  timeStepList, const std::vector< bool > &  valid  ) const

overrideprotectedvirtual

Virtual method for resolving a single time step from a set of time steps returned from processing threads.

Returns

Time step (dt) for the iteration update based on a list of time steps generated from the threaded calculated change method (one for each region processed).

Parameters

timeStepList	The set of time changes compiled from all the threaded calls to ThreadedGenerateData.
valid	The set of flags indicating which of "list" elements are valid

The default is to return the minimum value in the list.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::SetDifferenceFunction ( FiniteDifferenceFunctionType *  differenceFunction )

inlineoverride

This method sets the pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns

A FiniteDifferenceObject pointer.

Definition at line 88 of file itkGPUFiniteDifferenceImageFilter.h.

Referenced by itk::GPUGradientAnisotropicDiffusionImageFilter< TInputImage, TOutputImage, TParentImageFilter >::GPUGradientAnisotropicDiffusionImageFilter().

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

virtual void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::SetState ( FilterStateType  _arg )

virtual

Set/Get the state of the filter.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::SetStateToInitialized ( )

inline

Set the state of the filter to INITIALIZED

Definition at line 102 of file itkGPUFiniteDifferenceImageFilter.h.

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

void itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::SetStateToUninitialized ( )

inline

Set the state of the filter to UNINITIALIZED

Definition at line 108 of file itkGPUFiniteDifferenceImageFilter.h.

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

bool itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ThreadedHalt ( void *  )

inlineoverrideprotected

This method is similar to Halt(), and its default implementation in this class is simply to call Halt(). However, this method takes as a parameter a void pointer to the MultiThreaderBase::WorkUnitInfo structure. If you override this method instead of overriding Halt, you will be able to get the current thread ID and handle the Halt method accordingly. This is useful if you are doing a lot of processing in Halt that you don't want parallelized. Notice that ThreadedHalt is only called by the multithreaded filters, so you still should implement Halt, just in case a non-threaded filter is used.

Definition at line 191 of file itkGPUFiniteDifferenceImageFilter.h.

Member Data Documentation

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

constexpr unsigned int itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::ImageDimension = OutputImageType::ImageDimension

static

Dimensionality of input and output data is assumed to be the same.

Definition at line 58 of file itkGPUFiniteDifferenceImageFilter.h.

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

TimeProbe itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_ApplyUpdateTime

protected

Definition at line 250 of file itkGPUFiniteDifferenceImageFilter.h.

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

TimeProbe itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_ComputeUpdateTime

protected

Definition at line 250 of file itkGPUFiniteDifferenceImageFilter.h.

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

FiniteDifferenceFunctionType::Pointer itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_DifferenceFunction

private

The function that will be used in calculating updates for each pixel.

Definition at line 260 of file itkGPUFiniteDifferenceImageFilter.h.

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

TimeProbe itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_InitTime

protected

Timers for statistics

Definition at line 250 of file itkGPUFiniteDifferenceImageFilter.h.

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

bool itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_ManualReinitialization

protected

The maximum number of iterations this filter will run A counter for keeping track of the number of elapsed iterations during filtering. Indicates whether the filter automatically resets to UNINITIALIZED state after completing, or whether filter must be manually reset

Definition at line 244 of file itkGPUFiniteDifferenceImageFilter.h.

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

double itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_MaximumRMSError

protected

Definition at line 247 of file itkGPUFiniteDifferenceImageFilter.h.

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

double itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_RMSChange

protected

Definition at line 246 of file itkGPUFiniteDifferenceImageFilter.h.

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

TimeProbe itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_SmoothFieldTime

protected

Definition at line 250 of file itkGPUFiniteDifferenceImageFilter.h.

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

FilterStateType itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_State

private

State that the filter is in, i.e. UNINITIALIZED or INITIALIZED

Definition at line 267 of file itkGPUFiniteDifferenceImageFilter.h.

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

bool itk::GPUFiniteDifferenceImageFilter< TInputImage, TOutputImage, TParentImageFilter >::m_UseImageSpacing

private

Control whether derivatives use spacing of the input image in its calculation.

Definition at line 264 of file itkGPUFiniteDifferenceImageFilter.h.

---

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

• itkGPUFiniteDifferenceImageFilter.h