itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkTestingComparisonImageFilter.h>

Inheritance diagram for itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types
typedef NumericTraits < RealType >::AccumulateType	AccumulateType
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef OutputImageType::PixelType	OutputPixelType
typedef SmartPointer< Self >	Pointer
typedef NumericTraits < OutputPixelType >::RealType	RealType
typedef ComparisonImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	SetTestInput (const InputImageType *testImage)
virtual void	SetValidInput (const InputImageType *validImage)
virtual void	SetToleranceRadius (int _arg)
virtual int	GetToleranceRadius () const
virtual void	SetDifferenceThreshold (OutputPixelType _arg)
virtual OutputPixelType	GetDifferenceThreshold () const
virtual void	SetIgnoreBoundaryPixels (bool _arg)
virtual bool	GetIgnoreBoundaryPixels () const
virtual OutputPixelType	GetMinimumDifference () const
virtual OutputPixelType	GetMaximumDifference () const
virtual RealType	GetMeanDifference () const
virtual AccumulateType	GetTotalDifference () const
virtual SizeValueType	GetNumberOfPixelsWithDifferences () const
virtual void	SetInput (const TInputImage *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
const TInputImage *	GetInput (void) const
const TInputImage *	GetInput (unsigned int idx) const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	AfterThreadedGenerateData ()
void	BeforeThreadedGenerateData ()
	ComparisonImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &threadRegion, ThreadIdType threadId)
virtual	~ComparisonImageFilter ()
Protected Attributes
OutputPixelType	m_DifferenceThreshold
OutputPixelType	m_MaximumDifference
RealType	m_MeanDifference
OutputPixelType	m_MinimumDifference
SizeValueType	m_NumberOfPixelsWithDifferences
Array< AccumulateType >	m_ThreadDifferenceSum
Array< OutputPixelType >	m_ThreadMaximumDifference
Array< OutputPixelType >	m_ThreadMinimumDifference
Array< SizeValueType >	m_ThreadNumberOfPixels
int	m_ToleranceRadius
AccumulateType	m_TotalDifference
Private Member Functions
	ComparisonImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
bool	m_IgnoreBoundaryPixels

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >

Implements comparison between 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. The comparison value is computed by visiting all the pixels in the baseline images and comparing their values with the pixel values in the neighborhood of the homologous pixel in the other image.

Definition at line 42 of file itkTestingComparisonImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef NumericTraits< RealType >::AccumulateType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::AccumulateType

Definition at line 65 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 50 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 56 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 60 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 63 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 61 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 62 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 49 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef NumericTraits< OutputPixelType >::RealType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::RealType

Definition at line 64 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef ComparisonImageFilter itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 47 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef ImageSource< TOutputImage > itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 48 of file itkTestingComparisonImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::ComparisonImageFilter

(

)

[protected]

template<class TInputImage , class TOutputImage >

virtual itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::~ComparisonImageFilter

(

)

[inline, protected, virtual]

Definition at line 111 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::ComparisonImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData

(

void

)

[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::Testing::ComparisonImageFilter< 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::itk::LightObject::Pointer itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >

virtual OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetDifferenceThreshold

(

)

const [virtual]

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

template<class TInputImage , class TOutputImage >

virtual bool itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetIgnoreBoundaryPixels

(

)

const [virtual]

Set/Get ignore boundary pixels. Useful when resampling may have introduced difference pixel values along the image edge Default = false

template<class TInputImage , class TOutputImage >

const TInputImage* itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetInput

(

void

)

const

template<class TInputImage , class TOutputImage >

const TInputImage* itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetInput

(

unsigned int

idx

)

const

template<class TInputImage , class TOutputImage >

virtual OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetMaximumDifference

(

)

const [virtual]

Get statistical attributes for those pixels which exceed the tolerance and radius parameters

template<class TInputImage , class TOutputImage >

virtual RealType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetMeanDifference

(

)

const [virtual]

Get statistical attributes for those pixels which exceed the tolerance and radius parameters

template<class TInputImage , class TOutputImage >

virtual OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetMinimumDifference

(

)

const [virtual]

Get statistical attributes for those pixels which exceed the tolerance and radius parameters

template<class TInputImage , class TOutputImage >

virtual const char* itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual SizeValueType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetNumberOfPixelsWithDifferences

(

)

const [virtual]

Get statistical attributes for those pixels which exceed the tolerance and radius parameters

template<class TInputImage , class TOutputImage >

virtual int itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetToleranceRadius

(

)

const [virtual]

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

template<class TInputImage , class TOutputImage >

virtual AccumulateType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetTotalDifference

(

)

const [virtual]

Get statistical attributes for those pixels which exceed the tolerance and radius parameters

template<class TInputImage , class TOutputImage >

static Pointer itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >

void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::operator=

(

const Self &

)

[private]

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::Testing::ComparisonImageFilter< 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::ProcessObject.

template<class TInputImage , class TOutputImage >

virtual void itk::Testing::ComparisonImageFilter< 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::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::SetIgnoreBoundaryPixels

(

bool

_arg

)

[virtual]

Set/Get ignore boundary pixels. Useful when resampling may have introduced difference pixel values along the image edge Default = false

template<class TInputImage , class TOutputImage >

virtual void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::SetInput

(

const TInputImage *

image

)

[virtual]

template<class TInputImage , class TOutputImage >

virtual void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::SetInput	(	unsigned	int,
		const TInputImage *	image
	)		[virtual]

template<class TInputImage , class TOutputImage >

virtual void itk::Testing::ComparisonImageFilter< 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::Testing::ComparisonImageFilter< 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::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::SetValidInput

(

const InputImageType *

validImage

)

[virtual]

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

template<class TInputImage , class TOutputImage >

void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	threadRegion,
		ThreadIdType	threadId
	)		[protected, virtual]

ComparisonImageFilter 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"

Reimplemented from itk::ImageSource< TOutputImage >.

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_DifferenceThreshold [protected]

Definition at line 131 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

bool itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_IgnoreBoundaryPixels [private]

Definition at line 153 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_MaximumDifference [protected]

Definition at line 135 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

RealType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_MeanDifference [protected]

Definition at line 133 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_MinimumDifference [protected]

Definition at line 134 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

SizeValueType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_NumberOfPixelsWithDifferences [protected]

Definition at line 139 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

Array< AccumulateType > itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadDifferenceSum [protected]

Definition at line 143 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

Array< OutputPixelType > itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadMaximumDifference [protected]

Definition at line 147 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

Array< OutputPixelType > itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadMinimumDifference [protected]

Definition at line 146 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

Array< SizeValueType > itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadNumberOfPixels [protected]

Definition at line 144 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

int itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ToleranceRadius [protected]

Definition at line 141 of file itkTestingComparisonImageFilter.h.

template<class TInputImage , class TOutputImage >

AccumulateType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_TotalDifference [protected]

Definition at line 137 of file itkTestingComparisonImageFilter.h.

---

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

• itkTestingComparisonImageFilter.h