#include <itkFiniteDifferenceImageFilter.h>

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

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef FiniteDifferenceFunction < TOutputImage >	FiniteDifferenceFunctionType
typedef TInputImage	InputImageType
typedef TInputImage::PixelType	InputPixelType
typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType
typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType
typedef TOutputImage	OutputImageType
typedef TOutputImage::PixelType	OutputPixelType
typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType
typedef OutputPixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef FiniteDifferenceFunctionType::RadiusType	RadiusType
typedef FiniteDifferenceImageFilter	Self
typedef InPlaceImageFilter < TInputImage, TOutputImage >	Superclass
typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType
Public Member Functions
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const
virtual const IdentifierType &	GetElapsedIterations ()
virtual bool	GetIsInitialized ()
virtual const char *	GetNameOfClass () const
virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
virtual void	SetIsInitialized (bool _arg)
void	SetStateToInitialized ()
void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)
virtual const IdentifierType &	GetNumberOfIterations ()

virtual void	SetUseImageSpacing (bool _arg)
virtual void	UseImageSpacingOn ()
virtual void	UseImageSpacingOff ()
virtual const bool &	GetUseImageSpacing ()

virtual void	SetMaximumRMSError (double _arg)
virtual const double &	GetMaximumRMSError ()

virtual void	SetRMSChange (double _arg)
virtual const double &	GetRMSChange ()

virtual void	SetManualReinitialization (bool _arg)
virtual const bool &	GetManualReinitialization ()
virtual void	ManualReinitializationOn ()
virtual void	ManualReinitializationOff ()
Static Public Attributes
static const unsigned int	ImageDimension = OutputImageType::ImageDimension
Protected Member Functions
virtual void	AllocateUpdateBuffer ()=0
virtual void	ApplyUpdate (const TimeStepType &dt)=0
virtual TimeStepType	CalculateChange ()=0
virtual void	CopyInputToOutput ()=0
	FiniteDifferenceImageFilter ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual bool	Halt ()
virtual void	Initialize ()
virtual void	InitializeIteration ()
virtual void	PostProcessOutput ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
virtual void	SetElapsedIterations (IdentifierType _arg)
virtual bool	ThreadedHalt (void *)
virtual	~FiniteDifferenceImageFilter ()
Protected Attributes
IdentifierType	m_ElapsedIterations
bool	m_IsInitialized
bool	m_ManualReinitialization
double	m_MaximumRMSError
IdentifierType	m_NumberOfIterations
double	m_RMSChange
Private Member Functions
	FiniteDifferenceImageFilter (const Self &)
void	InitializeFunctionCoefficients ()
void	operator= (const Self &)
Private Attributes
FiniteDifferenceFunctionType::Pointer	m_DifferenceFunction
bool	m_UseImageSpacing

Detailed Description

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

The Finite Difference Solver Hierarchy

: This is an overview of the Finite Difference Solver (FDS) framework. The FDS framework is a set of classes for creating filters to solve partial differential equations on images using an iterative, finite difference update scheme.

: The high-level algorithm implemented by the framework can be described by the following pseudocode.

  WHILE NOT convergence:
     FOR ALL pixels i
        time_step = calculate_change(i)
        update(i, time_step)

: The following equation describes update at pixel on discrete image :

$u_{\mathbf{i}}^{n+1}=u^n_{\mathbf{i}}+\Delta u^n_{\mathbf{i}}\Delta t$

Component objects: The FDS hierarchy is comprised of two component object types, variations of which are designed to be plugged together to create filters for different applications. At the process level are the "solver" objects, which are subclasses of FiniteDifferenceImageFilter. Solver objects are filters that take image inputs and produce image outputs. Solver objects require a FiniteDifferenceFunction object to perform the calculation at each image pixel during iteration. These specialized function objects are subclasses of FiniteDifferenceFunction. FiniteDifferenceFunction take a neighborhood of pixels as input (in the form of an itk::NeighborhoodIterator) and produce a scalar valued result.

: Filters for different applications are created by defining a function object to handle the numerical calculations and choosing (or creating) a solver object that reflects the requirements and constraints of the application.

For example, anisotropic diffusion filters are created by plugging anisotropic diffusion functions into the DenseFiniteDifferenceImageFilter.

The separation between function object and solver object allows us to create, for example, sparse-field, dense-field, and narrow-band implementations of a level-set surface evolution filter can all be constructed by plugging the same function object into three different, specialized solvers.

Creating new filters in this hierarchy: The procedure for creating a filter within the FDS hierarchy is to identify all the virtual methods that need to be defined for your particular application. In the simplest case, a filter needs only to instantiate a specific function object and define some halting criteria. For more complicated applications, you may need to define a specialized type of iteration scheme or updating procedure in a higher-level solver object.

: Some simple examples are the specific subclasses of AnisotropicDiffusionImageFilter. The leaves of the anisotropic diffusion filter tree only define the function object they use for their particular flavor of diffusion. See CurvatureAnisotropicDiffusionImageFilter and GradientAnisotropicDiffusionImageFilter for details.

FiniteDifferenceImageFilter: This class defines the generic solver API at the top level of the FDS framework. FiniteDifferenceImageFilter is an abstract class that implements the generic, high-level algorithm (described above).

Inputs and Outputs: This filter is an ImageToImage filter. Depending on the specific subclass implementation, finite difference image filters may process a variety of image types. The input to the filter is the initial value of and the output of the filter is the solution to the P.D.E.

How to use this class

GenerateData() relies on several virtual methods that must be defined by a subclass. Specifically:

AllocateUpdateBuffer()
ApplyUpdate()
CalculateChange()
Halt(). To create a finite difference solver, implement a subclass to define these methods.

: Note that there is no fixed container type for the buffer used to hold the update $\Delta$ . The container might be another image, or simply a list of values. AllocateUpdateBuffer is responsible for creating the $\Delta$ container. CalculateChange populates this buffer and ApplyUpdate adds the buffer values to the output image (solution). The boolean Halt() (or ThreadedHalt()) method returns a true value to stop iteration.

See also:: DenseFiniteDifferenceImageFilter

Definition at line 132 of file itkFiniteDifferenceImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage>

typedef SmartPointer< const Self > itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 141 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef FiniteDifferenceFunction< TOutputImage > itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::FiniteDifferenceFunctionType

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.

Reimplemented in itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::CurvatureRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TImageForceFunction >, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DiffeomorphicDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, and itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 165 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InputImageType

Input and output image types.

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

Definition at line 144 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::PixelType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 155 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef NumericTraits< InputPixelType >::ValueType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InputPixelValueType

Definition at line 160 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::NeighborhoodScalesType

Reimplemented in itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, and itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 169 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TOutputImage itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::OutputImageType

Superclass typedefs.

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

Definition at line 148 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TOutputImage::PixelType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::OutputPixelType

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

Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

Definition at line 154 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef NumericTraits< OutputPixelType >::ValueType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::OutputPixelValueType

Extract value type in case the pixel is of vector type

Definition at line 159 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef OutputPixelType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::PixelType

Reimplemented in itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, and itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 156 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef SmartPointer< Self > itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 140 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef FiniteDifferenceFunctionType::RadiusType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::RadiusType

Definition at line 168 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef FiniteDifferenceImageFilter itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 138 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef InPlaceImageFilter< TInputImage, TOutputImage > itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 139 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef FiniteDifferenceFunctionType::TimeStepType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::TimeStepType

Definition at line 166 of file itkFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>

itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::FiniteDifferenceImageFilter ( ) [protected]

template<class TInputImage, class TOutputImage>

virtual itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::~FiniteDifferenceImageFilter ( ) [protected, virtual]

template<class TInputImage, class TOutputImage>

itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::FiniteDifferenceImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( ) [protected, pure virtual]

This method allocates a temporary update container in the subclass.

Implemented in itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::DiffeomorphicDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, and itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( const TimeStepType & dt ) [protected, pure 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.

Implemented in itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, and itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

template<class TInputImage, class TOutputImage>

virtual TimeStepType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::CalculateChange ( ) [protected, pure 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::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, and itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::CopyInputToOutput ( ) [protected, pure 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::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, and itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]

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::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

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()

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

Reimplemented in itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<class TInputImage, class TOutputImage>

virtual const FiniteDifferenceFunctionType ::Pointer& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetDifferenceFunction ( ) const [virtual]

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.

template<class TInputImage, class TOutputImage>

virtual const IdentifierType& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetElapsedIterations ( ) [virtual]

Get the number of elapsed iterations of the filter.

template<class TInputImage, class TOutputImage>

virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetIsInitialized ( ) [virtual]

template<class TInputImage, class TOutputImage>

virtual const bool& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetManualReinitialization ( ) [virtual]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

template<class TInputImage, class TOutputImage>

virtual const double& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetMaximumRMSError ( ) [virtual]

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

template<class TInputImage, class TOutputImage>

virtual const char* itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods)

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

template<class TInputImage, class TOutputImage>

virtual const IdentifierType& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetNumberOfIterations ( ) [virtual]

Set/Get the number of iterations that the filter will run.

template<class TInputImage, class TOutputImage>

virtual const double& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetRMSChange ( ) [virtual]

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

template<class TInputImage, class TOutputImage>

virtual const bool& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetUseImageSpacing ( ) [virtual]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

template<class TInputImage, class TOutputImage>

virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Halt ( ) [protected, virtual]

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

Reimplemented in itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >, itk::IsotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Initialize ( void ) [inline, protected, virtual]

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.

Reimplemented in itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::CurvatureRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TImageForceFunction >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, and itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 298 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::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<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InitializeIteration ( ) [inline, protected, virtual]

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.

Reimplemented in itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::CurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::VectorCurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DiffeomorphicDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 306 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ManualReinitializationOff ( ) [virtual]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ManualReinitializationOn ( ) [virtual]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

template<class TInputImage, class TOutputImage>

void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::operator= ( const Self & ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::PostProcessOutput ( ) [inline, protected, virtual]

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

Reimplemented in itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, and itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 329 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

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::InPlaceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

virtual TimeStepType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ResolveTimeStep	(	const std::vector< TimeStepType > &	timeStepList,
		const std::vector< bool > &	valid
	)		const `[protected, virtual]`

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<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetDifferenceFunction ( FiniteDifferenceFunctionType * _arg ) [virtual]

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.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetElapsedIterations ( IdentifierType _arg ) [protected, virtual]

Set the number of elapsed iterations of the filter.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetIsInitialized ( bool _arg ) [virtual]

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetManualReinitialization ( bool _arg ) [virtual]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetMaximumRMSError ( double _arg ) [virtual]

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetNumberOfIterations ( IdentifierType _arg ) [virtual]

Set/Get the number of iterations that the filter will run.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetRMSChange ( double _arg ) [virtual]

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

template<class TInputImage, class TOutputImage>

void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetStateToInitialized ( ) [inline]

Definition at line 220 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetStateToUninitialized ( ) [inline]

Definition at line 219 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetUseImageSpacing ( bool _arg ) [virtual]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

template<class TInputImage, class TOutputImage>

virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ThreadedHalt ( void * ) [inline, protected, virtual]

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 MultiThreader::ThreadInfoStruct 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 291 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::UseImageSpacingOff ( ) [virtual]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

template<class TInputImage, class TOutputImage>

virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::UseImageSpacingOn ( ) [virtual]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

Member Data Documentation

template<class TInputImage, class TOutputImage>

const unsigned int itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ImageDimension = OutputImageType::ImageDimension [static]

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

Definition at line 151 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

FiniteDifferenceFunctionType::Pointer itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_DifferenceFunction [private]

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

Definition at line 359 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

IdentifierType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_ElapsedIterations [protected]

A counter for keeping track of the number of elapsed iterations during filtering.

Definition at line 336 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_IsInitialized [protected]

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

Definition at line 236 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_ManualReinitialization [protected]

Indicates whether the filter automatically resets to UNINITIALIZED state after completing, or whether filter must be manually reset

Definition at line 340 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

double itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_MaximumRMSError [protected]

Definition at line 343 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

IdentifierType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_NumberOfIterations [protected]

The maximum number of iterations this filter will run

Definition at line 332 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

double itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_RMSChange [protected]

Definition at line 342 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>

bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing [private]

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

Definition at line 356 of file itkFiniteDifferenceImageFilter.h.

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

itkFiniteDifferenceImageFilter.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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