Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::DifferenceImageFilter< TInputImage, TOutputImage > Class Template Reference
[Intensity Image FiltersMultithreaded Filters]

Implements pixel-wise comparison of two images. More...

#include <itkDifferenceImageFilter.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::DifferenceImageFilter< TInputImage, TOutputImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef DifferenceImageFilter Self
typedef ImageToImageFilter<
TInputImage, TOutputImage > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TInputImage InputImageType
typedef TOutputImage OutputImageType
typedef OutputImageType::PixelType OutputPixelType
typedef OutputImageType::RegionType OutputImageRegionType
typedef NumericTraits< OutputPixelType
>::RealType 
RealType
typedef NumericTraits< RealType
>::AccumulateType 
AccumulateType

Public Member Functions

virtual const char * GetNameOfClass () const
virtual void SetValidInput (const InputImageType *validImage)
virtual void SetTestInput (const InputImageType *testImage)
virtual void SetToleranceRadius (int _arg)
virtual int GetToleranceRadius ()
virtual void SetDifferenceThreshold (OutputPixelType _arg)
virtual OutputPixelType GetDifferenceThreshold ()
virtual RealType GetMeanDifference ()
virtual AccumulateType GetTotalDifference ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 DifferenceImageFilter ()
virtual ~DifferenceImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &threadRegion, int threadId)
void BeforeThreadedGenerateData ()
void AfterThreadedGenerateData ()

Protected Attributes

OutputPixelType m_DifferenceThreshold
RealType m_MeanDifference
AccumulateType m_TotalDifference
int m_ToleranceRadius
Array< AccumulateTypem_ThreadDifferenceSum

Detailed Description

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

Implements pixel-wise comparison of two images.

This filter is used by the testing system to compute the difference between a valid image and an image produced by the test.

Definition at line 36 of file itkDifferenceImageFilter.h.


Member Typedef Documentation

template<class TInputImage, class TOutputImage>
typedef NumericTraits<RealType>::AccumulateType itk::DifferenceImageFilter< TInputImage, TOutputImage >::AccumulateType
 

Definition at line 58 of file itkDifferenceImageFilter.h.

Referenced by itk::DifferenceImageFilter< TInputImage, TOutputImage >::~DifferenceImageFilter().

template<class TInputImage, class TOutputImage>
typedef SmartPointer<const Self> itk::DifferenceImageFilter< TInputImage, TOutputImage >::ConstPointer
 

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

Definition at line 44 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage itk::DifferenceImageFilter< TInputImage, TOutputImage >::InputImageType
 

Some convenient typedefs.

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

Definition at line 53 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef OutputImageType::RegionType itk::DifferenceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType
 

Superclass typedefs.

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

Definition at line 56 of file itkDifferenceImageFilter.h.

Referenced by itk::DifferenceImageFilter< TInputImage, TOutputImage >::~DifferenceImageFilter().

template<class TInputImage, class TOutputImage>
typedef TOutputImage itk::DifferenceImageFilter< TInputImage, TOutputImage >::OutputImageType
 

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 54 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef OutputImageType::PixelType itk::DifferenceImageFilter< TInputImage, TOutputImage >::OutputPixelType
 

Definition at line 55 of file itkDifferenceImageFilter.h.

Referenced by itk::DifferenceImageFilter< TInputImage, TOutputImage >::~DifferenceImageFilter().

template<class TInputImage, class TOutputImage>
typedef SmartPointer<Self> itk::DifferenceImageFilter< TInputImage, TOutputImage >::Pointer
 

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

Definition at line 43 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef NumericTraits<OutputPixelType>::RealType itk::DifferenceImageFilter< TInputImage, TOutputImage >::RealType
 

Definition at line 57 of file itkDifferenceImageFilter.h.

Referenced by itk::DifferenceImageFilter< TInputImage, TOutputImage >::~DifferenceImageFilter().

template<class TInputImage, class TOutputImage>
typedef DifferenceImageFilter itk::DifferenceImageFilter< TInputImage, TOutputImage >::Self
 

Standard class typedefs.

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

Definition at line 41 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef ImageToImageFilter<TInputImage,TOutputImage> itk::DifferenceImageFilter< TInputImage, TOutputImage >::Superclass
 

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

Definition at line 42 of file itkDifferenceImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
itk::DifferenceImageFilter< TInputImage, TOutputImage >::DifferenceImageFilter  )  [protected]
 

template<class TInputImage, class TOutputImage>
virtual itk::DifferenceImageFilter< TInputImage, TOutputImage >::~DifferenceImageFilter  )  [inline, protected, virtual]
 

Definition at line 85 of file itkDifferenceImageFilter.h.

References itk::DifferenceImageFilter< TInputImage, TOutputImage >::AccumulateType, itk::DifferenceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType, itk::DifferenceImageFilter< TInputImage, TOutputImage >::OutputPixelType, and itk::DifferenceImageFilter< TInputImage, TOutputImage >::RealType.


Member Function Documentation

template<class TInputImage, class TOutputImage>
void itk::DifferenceImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData  )  [protected, virtual]
 

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>
void itk::DifferenceImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData void   )  [protected, virtual]
 

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage>
virtual OutputPixelType itk::DifferenceImageFilter< TInputImage, TOutputImage >::GetDifferenceThreshold  )  [virtual]
 

Set/Get the minimum threshold for pixels to be different. Default is 0.

template<class TInputImage, class TOutputImage>
virtual RealType itk::DifferenceImageFilter< TInputImage, TOutputImage >::GetMeanDifference  )  [virtual]
 

Get parameters of the difference image after execution.

template<class TInputImage, class TOutputImage>
virtual const char* itk::DifferenceImageFilter< TInputImage, TOutputImage >::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

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

template<class TInputImage, class TOutputImage>
virtual int itk::DifferenceImageFilter< TInputImage, TOutputImage >::GetToleranceRadius  )  [virtual]
 

Set/Get the maximum distance away to look for a matching pixel. Default is 0.

template<class TInputImage, class TOutputImage>
virtual AccumulateType itk::DifferenceImageFilter< TInputImage, TOutputImage >::GetTotalDifference  )  [virtual]
 

Get parameters of the difference image after execution.

template<class TInputImage, class TOutputImage>
Pointer itk::DifferenceImageFilter< TInputImage, TOutputImage >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage>
void itk::DifferenceImageFilter< 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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>
virtual void itk::DifferenceImageFilter< TInputImage, TOutputImage >::SetDifferenceThreshold OutputPixelType  _arg  )  [virtual]
 

Set/Get the minimum threshold for pixels to be different. Default is 0.

template<class TInputImage, class TOutputImage>
virtual void itk::DifferenceImageFilter< TInputImage, TOutputImage >::SetTestInput const InputImageType testImage  )  [virtual]
 

Set the test image input. This will be input 1.

template<class TInputImage, class TOutputImage>
virtual void itk::DifferenceImageFilter< TInputImage, TOutputImage >::SetToleranceRadius int  _arg  )  [virtual]
 

Set/Get the maximum distance away to look for a matching pixel. Default is 0.

template<class TInputImage, class TOutputImage>
virtual void itk::DifferenceImageFilter< TInputImage, TOutputImage >::SetValidInput const InputImageType validImage  )  [virtual]
 

Set the valid image input. This will be input 0.

template<class TInputImage, class TOutputImage>
void itk::DifferenceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData const OutputImageRegionType threadRegion,
int  threadId
[protected, virtual]
 

DifferenceImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.


Member Data Documentation

template<class TInputImage, class TOutputImage>
OutputPixelType itk::DifferenceImageFilter< TInputImage, TOutputImage >::m_DifferenceThreshold [protected]
 

Definition at line 106 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
RealType itk::DifferenceImageFilter< TInputImage, TOutputImage >::m_MeanDifference [protected]
 

Definition at line 107 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
Array<AccumulateType> itk::DifferenceImageFilter< TInputImage, TOutputImage >::m_ThreadDifferenceSum [protected]
 

Definition at line 111 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
int itk::DifferenceImageFilter< TInputImage, TOutputImage >::m_ToleranceRadius [protected]
 

Definition at line 109 of file itkDifferenceImageFilter.h.

template<class TInputImage, class TOutputImage>
AccumulateType itk::DifferenceImageFilter< TInputImage, TOutputImage >::m_TotalDifference [protected]
 

Definition at line 108 of file itkDifferenceImageFilter.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 00:48:17 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000