Medical Imaging Interaction Toolkit  2018.4.99-87d68d9f
Medical Imaging Interaction Toolkit
mitk::CompareImageDataFilter Class Reference

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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter Self
 
typedef ImageSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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)
 
InputImageTypeGetInput (void)
 
InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
- Public Member Functions inherited from mitk::ImageSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 
virtual const vtkImageData * GetVtkImageData () const
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (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 ()
 
 ~CompareImageDataFilter () override
 
void GenerateData () override
 
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 ()
 
 ~ImageToImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
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...
 
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 ()
 
 ~BaseDataSource () override
 

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 64 of file mitkCompareImageDataFilter.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ CompareImageDataFilter()

mitk::CompareImageDataFilter::CompareImageDataFilter ( )
protected

Definition at line 23 of file mitkCompareImageDataFilter.cpp.

References ResetCompareResultsToInitial().

◆ ~CompareImageDataFilter()

mitk::CompareImageDataFilter::~CompareImageDataFilter ( )
inlineoverrideprotected

Definition at line 91 of file mitkCompareImageDataFilter.h.

Member Function Documentation

◆ EstimateValueDifference()

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

◆ GenerateData()

◆ GetClassHierarchy()

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

Reimplemented from mitk::ImageToImageFilter.

Definition at line 67 of file mitkCompareImageDataFilter.h.

◆ GetClassName()

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

Reimplemented from mitk::ImageToImageFilter.

◆ GetCompareResults()

CompareFilterResults mitk::CompareImageDataFilter::GetCompareResults ( )
inline

Get the detailed results of the comparision run.

See also
CompareFilterResults

Definition at line 87 of file mitkCompareImageDataFilter.h.

◆ GetResult()

bool mitk::CompareImageDataFilter::GetResult ( vcl_size_t  threshold = 0)

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
thresholdAllowed amount of pixels with differences

Definition at line 72 of file mitkCompareImageDataFilter.cpp.

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

◆ GetStaticNameOfClass()

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

Definition at line 67 of file mitkCompareImageDataFilter.h.

◆ itkSimpleNewMacro()

mitk::CompareImageDataFilter::itkSimpleNewMacro ( Self  )

◆ ResetCompareResultsToInitial()

◆ SetTolerance()

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

Definition at line 88 of file mitkCompareImageDataFilter.h.

References mitk::eps.

Member Data Documentation

◆ m_CompareDetails

CompareFilterResults mitk::CompareImageDataFilter::m_CompareDetails
protected

◆ m_CompareResult

bool mitk::CompareImageDataFilter::m_CompareResult
protected

Definition at line 101 of file mitkCompareImageDataFilter.h.

Referenced by EstimateValueDifference(), GenerateData(), and GetResult().

◆ m_Tolerance

double mitk::CompareImageDataFilter::m_Tolerance
protected

Definition at line 104 of file mitkCompareImageDataFilter.h.

Referenced by EstimateValueDifference(), and GenerateData().


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