Filter for comparing two mitk::Image objects by pixel values. More...

#include <mitkCompareImageDataFilter.h>

Inheritance diagram for mitk::CompareImageDataFilter:

Collaboration diagram for mitk::CompareImageDataFilter:

Public Types
typedef CompareImageDataFilter	Self

typedef ImageToImageFilter	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter	Self

typedef ImageSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef mitk::Image	InputImageType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef SlicedData::RegionType	InputImageRegionType

Public Types inherited from mitk::ImageSource
typedef ImageSource	Self

typedef BaseDataSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef mitk::Image	OutputImageType
	Some convenient typedefs. More...

typedef OutputImageType	OutputType

typedef OutputImageType::Pointer	OutputImagePointer

typedef SlicedData::RegionType	OutputImageRegionType

Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource	Self

typedef itk::ProcessObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef BaseData	OutputType

typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

	itkSimpleNewMacro (Self) bool GetResult(vcl_size_t threshold=0)
	Get the result of the comparison. More...

CompareFilterResults	GetCompareResults ()
	Get the detailed results of the comparision run. More...

void	SetTolerance (double eps)

Public Member Functions inherited from mitk::ImageToImageFilter
Pointer	Clone () const

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const InputImageType *image)

InputImageType *	GetInput (void)

InputImageType *	GetInput (unsigned int idx)

const InputImageType *	GetInput (void) const

const InputImageType *	GetInput (unsigned int idx) const

Public Member Functions inherited from mitk::ImageSource
Pointer	Clone () const

OutputType *	GetOutput ()
	Get the output data of this image source object. More...

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

virtual itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Make a DataObject of the correct type to used as the specified output. More...

virtual itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual vtkImageData *	GetVtkImageData ()

virtual const vtkImageData *	GetVtkImageData () const

Public Member Functions inherited from mitk::BaseDataSource
OutputType *	GetOutput ()

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

virtual void	GraftOutput (OutputType *output)
	Graft the specified BaseData onto this BaseDataSource's output. More...

virtual void	GraftOutput (const DataObjectIdentifierType &key, OutputType *output)

virtual void	GraftNthOutput (unsigned int idx, OutputType *output)
	Graft the specified base data object onto this BaseDataSource's idx'th output. More...

bool	Updating () const
	Access itk::ProcessObject::m_Updating. More...

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

Static Public Member Functions inherited from mitk::ImageToImageFilter
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

Static Public Member Functions inherited from mitk::ImageSource
static const char *	GetStaticNameOfClass ()

static Pointer	New ()
	Method for creation through the object factory. More...

Static Public Member Functions inherited from mitk::BaseDataSource
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	CompareImageDataFilter ()

virtual	~CompareImageDataFilter ()

virtual void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...

void	ResetCompareResultsToInitial ()
	Method resets the compare detail memeber struct to its initial state. More...

template<typename TPixel , unsigned int VImageDimension>
void	EstimateValueDifference (const itk::Image< TPixel, VImageDimension > itkImage1, const mitk::Image referenceImage)

Protected Member Functions inherited from mitk::ImageToImageFilter
	ImageToImageFilter ()

virtual	~ImageToImageFilter ()

virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const override

virtual void	GenerateInputRequestedRegion () override

Protected Member Functions inherited from mitk::ImageSource
	ImageSource ()

virtual	~ImageSource ()

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
	If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...

virtual void	PrepareOutputs () override
	This method is intentionally left blank. More...

virtual void	AllocateOutputs ()
	The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...

virtual void	BeforeThreadedGenerateData ()
	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(). More...

virtual void	AfterThreadedGenerateData ()
	If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
	Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...

Protected Member Functions inherited from mitk::BaseDataSource
	BaseDataSource ()

virtual	~BaseDataSource ()

Protected Attributes
bool	m_CompareResult

CompareFilterResults	m_CompareDetails

double	m_Tolerance

Additional Inherited Members
Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
	Static function used as a "callback" by the MultiThreader. More...

Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer	New ()

Detailed Description

Filter for comparing two mitk::Image objects by pixel values.

The comparison is pixel-wise, the filter uses the itk::Testing::ComparisonImageFilter to find differences. The filter expects two images as input, provide them by using the SetInput( int, mitk::Image) method.

Definition at line 68 of file mitkCompareImageDataFilter.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::CompareImageDataFilter::ConstPointer

Definition at line 71 of file mitkCompareImageDataFilter.h.

typedef itk::SmartPointer<Self> mitk::CompareImageDataFilter::Pointer

Definition at line 71 of file mitkCompareImageDataFilter.h.

typedef CompareImageDataFilter mitk::CompareImageDataFilter::Self

Definition at line 71 of file mitkCompareImageDataFilter.h.

typedef ImageToImageFilter mitk::CompareImageDataFilter::Superclass

Definition at line 71 of file mitkCompareImageDataFilter.h.

Constructor & Destructor Documentation

mitk::CompareImageDataFilter::CompareImageDataFilter ( )

protected

Definition at line 27 of file mitkCompareImageDataFilter.cpp.

References ResetCompareResultsToInitial().

virtual mitk::CompareImageDataFilter::~CompareImageDataFilter ( )

inlineprotectedvirtual

Definition at line 96 of file mitkCompareImageDataFilter.h.

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension>

void mitk::CompareImageDataFilter::EstimateValueDifference	(	const itk::Image< TPixel, VImageDimension > *	itkImage1,
		const mitk::Image *	referenceImage
	)

protected

ITK-like method which calls the ComparisionFilter on the two inputs of the filter

Definition at line 92 of file mitkCompareImageDataFilter.cpp.

References mitk::CastToItkImage(), mitk::GrabItkImageMemory(), MITK_WARN, and mitk::New().

void mitk::CompareImageDataFilter::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters.

This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from mitk::ImageSource.

Definition at line 45 of file mitkCompareImageDataFilter.cpp.

References AccessByItk_1, mitk::PixelType::GetNumberOfComponents(), mitk::Image::GetPixelType(), and mitk::ImageToImageFilter::New().

virtual std::vector<std::string> mitk::CompareImageDataFilter::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::ImageToImageFilter.

Definition at line 71 of file mitkCompareImageDataFilter.h.

virtual const char* mitk::CompareImageDataFilter::GetClassName ( ) const

virtual

Reimplemented from mitk::ImageToImageFilter.

CompareFilterResults mitk::CompareImageDataFilter::GetCompareResults ( )

inline

Get the detailed results of the comparision run.

See also: CompareFilterResults

Definition at line 92 of file mitkCompareImageDataFilter.h.

static const char* mitk::CompareImageDataFilter::GetStaticNameOfClass ( )

inlinestatic

Definition at line 71 of file mitkCompareImageDataFilter.h.

mitk::CompareImageDataFilter::itkSimpleNewMacro ( Self )

pure virtual

Get the result of the comparison.

The method compares only the number of pixels with differences. It returns true if the amount is under the specified threshold. To get the complete results, use the GetCompareResults method.

Returns false also if the itk ComparisionImageFilter raises an exception during update.

Parameters

threshold Allowed amount of pixels with differences

void mitk::CompareImageDataFilter::ResetCompareResultsToInitial ( )

protected

Method resets the compare detail memeber struct to its initial state.

Definition at line 34 of file mitkCompareImageDataFilter.cpp.

References max().

Referenced by CompareImageDataFilter().

void mitk::CompareImageDataFilter::SetTolerance ( double eps )

inline

Definition at line 93 of file mitkCompareImageDataFilter.h.