mitk::MultiComponentImageDataComparisonFilter Class Reference

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

#include <mitkMultiComponentImageDataComparisonFilter.h>

Inheritance diagram for mitk::MultiComponentImageDataComparisonFilter:

Collaboration diagram for mitk::MultiComponentImageDataComparisonFilter:

Public Types
typedef MultiComponentImageDataComparisonFilter	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)
void	SetTestImage (const Image *_arg)
const Image *	GetTestImage ()
void	SetValidImage (const Image *_arg)
const Image *	GetValidImage ()
virtual void	SetTolerance (double _arg)
virtual double	GetTolerance ()
void	SetCompareFilterResult (CompareFilterResults *results)
CompareFilterResults *	GetCompareFilterResult ()
bool	GetResult (double threshold=0.0f)
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
	MultiComponentImageDataComparisonFilter ()
	~MultiComponentImageDataComparisonFilter ()
virtual void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...
template<typename TPixel >
void	CompareMultiComponentImage (const Image *testImage, const Image *validImage)
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
double	m_Tolerance
bool	m_CompareResult
CompareFilterResults *	m_CompareDetails

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 multi channel mitk::Image objects by channel wise by pixel values.

Documentation: The comparison is channel- / pixel-wise.

Definition at line 33 of file mitkMultiComponentImageDataComparisonFilter.h.

Member Typedef Documentation

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

Definition at line 36 of file mitkMultiComponentImageDataComparisonFilter.h.

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

Definition at line 36 of file mitkMultiComponentImageDataComparisonFilter.h.

typedef MultiComponentImageDataComparisonFilter mitk::MultiComponentImageDataComparisonFilter::Self

Definition at line 36 of file mitkMultiComponentImageDataComparisonFilter.h.

typedef ImageToImageFilter mitk::MultiComponentImageDataComparisonFilter::Superclass

Definition at line 36 of file mitkMultiComponentImageDataComparisonFilter.h.

Constructor & Destructor Documentation

mitk::MultiComponentImageDataComparisonFilter::MultiComponentImageDataComparisonFilter ( )

protected

Definition at line 27 of file mitkMultiComponentImageDataComparisonFilter.cpp.

mitk::MultiComponentImageDataComparisonFilter::~MultiComponentImageDataComparisonFilter ( )

protected

Definition at line 33 of file mitkMultiComponentImageDataComparisonFilter.cpp.

Member Function Documentation

template<typename TPixel >

void mitk::MultiComponentImageDataComparisonFilter::CompareMultiComponentImage ( const Image *  testImage, const Image *  validImage  )

protected

Definition at line 118 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References mitk::Image::GetDimension(), mitk::PixelType::GetNumberOfComponents(), mitk::Image::GetPixelType(), mitk::Image::GetVolumeData(), max(), and min().

void mitk::MultiComponentImageDataComparisonFilter::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 59 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References mitk::PixelType::GetComponentType(), mitk::Image::GetPixelType(), GetTestImage(), GetValidImage(), and mitkThrow.

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

inlineoverridevirtual

Reimplemented from mitk::ImageToImageFilter.

Definition at line 36 of file mitkMultiComponentImageDataComparisonFilter.h.

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

virtual

Reimplemented from mitk::ImageToImageFilter.

CompareFilterResults * mitk::MultiComponentImageDataComparisonFilter::GetCompareFilterResult

(

)

/brief Get the detailed results of the comparison run /sa CompareFilterResults

Definition at line 58 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References m_CompareDetails.

bool mitk::MultiComponentImageDataComparisonFilter::GetResult

(

double

threshold = 0.0f

)

/brief 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.

/param threshold Allowed percentage of pixels with differences (between 0.0...1.0)

Definition at line 34 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References m_CompareDetails, m_CompareResult, and mitk::CompareFilterResults::m_PixelsWithDifference.

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

inlinestatic

Definition at line 36 of file mitkMultiComponentImageDataComparisonFilter.h.

const Image * mitk::MultiComponentImageDataComparisonFilter::GetTestImage

(

)

Definition at line 52 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References mitk::ImageToImageFilter::GetInput().

Referenced by GenerateData().

virtual double mitk::MultiComponentImageDataComparisonFilter::GetTolerance ( )

virtual

const Image * mitk::MultiComponentImageDataComparisonFilter::GetValidImage

(

)

Definition at line 51 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References mitk::ImageToImageFilter::GetInput().

Referenced by GenerateData().

mitk::MultiComponentImageDataComparisonFilter::itkSimpleNewMacro

(

Self

)

void mitk::MultiComponentImageDataComparisonFilter::SetCompareFilterResult

(

CompareFilterResults *

results

)

/brief

Definition at line 53 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References m_CompareDetails.

void mitk::MultiComponentImageDataComparisonFilter::SetTestImage

(

const Image *

_arg

)

/brief

Definition at line 50 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References mitk::ImageToImageFilter::SetInput().

virtual void mitk::MultiComponentImageDataComparisonFilter::SetTolerance ( double  _arg )

virtual

/brief Specify the tolerance of the image data comparison /param Tolerance Default is 0.0f.

void mitk::MultiComponentImageDataComparisonFilter::SetValidImage

(

const Image *

_arg

)

/brief

Definition at line 49 of file mitkMultiComponentImageDataComparisonFilter.cpp.

References mitk::ImageToImageFilter::SetInput().

Member Data Documentation

CompareFilterResults* mitk::MultiComponentImageDataComparisonFilter::m_CompareDetails

protected

Definition at line 85 of file mitkMultiComponentImageDataComparisonFilter.h.

Referenced by GetCompareFilterResult(), GetResult(), and SetCompareFilterResult().

bool mitk::MultiComponentImageDataComparisonFilter::m_CompareResult

protected

Definition at line 83 of file mitkMultiComponentImageDataComparisonFilter.h.

Referenced by GetResult().

double mitk::MultiComponentImageDataComparisonFilter::m_Tolerance

protected

Definition at line 82 of file mitkMultiComponentImageDataComparisonFilter.h.

---

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

• mitkMultiComponentImageDataComparisonFilter.h
• mitkMultiComponentImageDataComparisonFilter.cpp