#include <itkDenseFiniteDifferenceImageFilter.h>

Inheritance diagram for itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >:

Classes
struct	DenseFDThreadStruct
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputImageType	OutputImageType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef DenseFiniteDifferenceImageFilter	Self
typedef FiniteDifferenceImageFilter < TInputImage, TOutputImage >	Superclass
typedef Superclass::TimeStepType	TimeStepType
typedef OutputImageType	UpdateBufferType
Public Member Functions
virtual const char *	GetNameOfClass () const
	typedef (Concept::MultiplyOperator< PixelType, double >) OutputTimesDoubleCheck
	typedef (Concept::AdditiveOperators< PixelType >) OutputAdditiveOperatorsCheck
	typedef (Concept::AdditiveAndAssignOperators< PixelType >) OutputAdditiveAndAssignOperatorsCheck
	typedef (Concept::Convertible< typename TInputImage::PixelType, PixelType >) InputConvertibleToOutputCheck
Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension
Protected Types
typedef UpdateBufferType::RegionType	ThreadRegionType
Protected Member Functions
virtual void	AllocateUpdateBuffer ()
virtual void	ApplyUpdate (const TimeStepType &dt)
virtual TimeStepType	CalculateChange ()
virtual void	CopyInputToOutput ()
virtual UpdateBufferType *	GetUpdateBuffer ()
virtual void	ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)

	DenseFiniteDifferenceImageFilter ()
	~DenseFiniteDifferenceImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
Private Member Functions
	DenseFiniteDifferenceImageFilter (const Self &)
void	operator= (const Self &)
Static Private Member Functions
static ITK_THREAD_RETURN_TYPE	ApplyUpdateThreaderCallback (void *arg)
static ITK_THREAD_RETURN_TYPE	CalculateChangeThreaderCallback (void *arg)
Private Attributes
UpdateBufferType::Pointer	m_UpdateBuffer

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >

This filter implements a layer of the finite difference solver hierarchy that performs ``dense'' iteration, ie. iteration over all pixels in the input and output at each change calculation and update step. Dense iteration is in contrast to a ``sparse'' iteration over a subset of the pixels. 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$

: The generic code for performing iterations and updates at each time step is inherited from the parent class. This class defines an update buffer for $\Delta$ and the methods CalculateChange() and ApplyUpdate(). These methods are designed to automatically thread their execution. $\Delta$ is defined as an image of identical size and type as the output image.

: As we descend through each layer in the hierarchy, we know more and more about the specific application of our filter. At this level, we have committed to iteration over each pixel in an image. We take advantage of that knowledge to multithread the iteration and update methods.

Inputs and Outputs: This is an image to image filter. The specific types of the images are not fixed at this level in the hierarchy.

How to use this class: This filter is only one layer in a branch the finite difference solver hierarchy. It does not define the function used in the CalculateChange() and it does not define the stopping criteria (Halt method). To use this class, subclass it to a specific instance that supplies a function and Halt() method.

See also:: FiniteDifferenceImageFilter

Definition at line 69 of file itkDenseFiniteDifferenceImageFilter.h.