ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
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 >:

Public Types

using AccumulateType = typename NumericTraits< RealType >::AccumulateType
 
using ConstPointer = SmartPointer< const Self >
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< OutputPixelType >::RealType
 
using Self = ComparisonImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
virtual void SetTestInput (const InputImageType *input)
 
virtual void SetValidInput (const InputImageType *input)
 
virtual void SetVerifyInputInformation (bool _arg)
 
virtual bool GetVerifyInputInformation () const
 
virtual void VerifyInputInformationOn ()
 
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 void IgnoreBoundaryPixelsOn ()
 
virtual OutputPixelType GetMinimumDifference () const
 
virtual OutputPixelType GetMaximumDifference () const
 
virtual RealType GetMeanDifference () const
 
virtual AccumulateType GetTotalDifference () const
 
virtual SizeValueType GetNumberOfPixelsWithDifferences () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void AfterThreadedGenerateData () override
 
void BeforeThreadedGenerateData () override
 
 ComparisonImageFilter ()
 
void DynamicThreadedGenerateData (const OutputImageRegionType &) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ThreadedGenerateData (const OutputImageRegionType &threadRegion, ThreadIdType threadId) override
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ComparisonImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AllocateOutputs ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

OutputPixelType m_DifferenceThreshold
 
OutputPixelType m_MaximumDifference
 
RealType m_MeanDifference
 
OutputPixelType m_MinimumDifference
 
SizeValueType m_NumberOfPixelsWithDifferences
 
Array< AccumulateTypem_ThreadDifferenceSum
 
Array< OutputPixelTypem_ThreadMaximumDifference
 
Array< OutputPixelTypem_ThreadMinimumDifference
 
Array< SizeValueTypem_ThreadNumberOfPixels
 
int m_ToleranceRadius
 
AccumulateType m_TotalDifference
 
bool m_VerifyInputInformation
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Private Attributes

bool m_IgnoreBoundaryPixels
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

Detailed Description

template<typename TInputImage, typename 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.

Examples
SphinxExamples/src/ImageCompareCommand.cxx.

Definition at line 43 of file itkTestingComparisonImageFilter.h.

Member Typedef Documentation

◆ AccumulateType

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::AccumulateType = typename NumericTraits<RealType>::AccumulateType

Definition at line 67 of file itkTestingComparisonImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 52 of file itkTestingComparisonImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 61 of file itkTestingComparisonImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::InputPixelType = typename InputImageType::PixelType

Definition at line 62 of file itkTestingComparisonImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 65 of file itkTestingComparisonImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 63 of file itkTestingComparisonImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 64 of file itkTestingComparisonImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 51 of file itkTestingComparisonImageFilter.h.

◆ RealType

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::RealType = typename NumericTraits<OutputPixelType>::RealType

Definition at line 66 of file itkTestingComparisonImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::Self = ComparisonImageFilter

Standard class type aliases.

Definition at line 49 of file itkTestingComparisonImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 50 of file itkTestingComparisonImageFilter.h.

Constructor & Destructor Documentation

◆ ComparisonImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::ComparisonImageFilter ( )
protected

◆ ~ComparisonImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::~ComparisonImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData ( )
overrideprotectedvirtual

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

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

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

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
inlineoverrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 131 of file itkTestingComparisonImageFilter.h.

◆ GetDifferenceThreshold()

template<typename TInputImage , typename TOutputImage >
virtual OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetDifferenceThreshold ( ) const
virtual

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

◆ GetIgnoreBoundaryPixels()

template<typename TInputImage , typename 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

◆ GetMaximumDifference()

template<typename TInputImage , typename TOutputImage >
virtual OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetMaximumDifference ( ) const
virtual

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

◆ GetMeanDifference()

template<typename TInputImage , typename TOutputImage >
virtual RealType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetMeanDifference ( ) const
virtual

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

◆ GetMinimumDifference()

template<typename TInputImage , typename TOutputImage >
virtual OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetMinimumDifference ( ) const
virtual

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

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >
virtual const char* itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

◆ GetNumberOfPixelsWithDifferences()

template<typename TInputImage , typename TOutputImage >
virtual SizeValueType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetNumberOfPixelsWithDifferences ( ) const
virtual

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

◆ GetToleranceRadius()

template<typename TInputImage , typename 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.

◆ GetTotalDifference()

template<typename TInputImage , typename TOutputImage >
virtual AccumulateType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetTotalDifference ( ) const
virtual

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

◆ GetVerifyInputInformation()

template<typename TInputImage , typename TOutputImage >
virtual bool itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::GetVerifyInputInformation ( ) const
virtual

Verify that the origin, spacing, and direction of both images match

◆ IgnoreBoundaryPixelsOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::IgnoreBoundaryPixelsOn ( )
virtual

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

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

◆ SetDifferenceThreshold()

template<typename TInputImage , typename 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.

◆ SetIgnoreBoundaryPixels()

template<typename TInputImage , typename 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

◆ SetTestInput()

template<typename TInputImage , typename TOutputImage >
virtual void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::SetTestInput ( const InputImageType input)
virtual

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

◆ SetToleranceRadius()

template<typename TInputImage , typename 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.

◆ SetValidInput()

template<typename TInputImage , typename TOutputImage >
virtual void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::SetValidInput ( const InputImageType input)
virtual

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

◆ SetVerifyInputInformation()

template<typename TInputImage , typename TOutputImage >
virtual void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::SetVerifyInputInformation ( bool  _arg)
virtual

Verify that the origin, spacing, and direction of both images match

◆ ThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType threadRegion,
ThreadIdType  threadId 
)
overrideprotectedvirtual

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

◆ VerifyInputInformation()

template<typename TInputImage , typename TOutputImage >
void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::VerifyInputInformation ( )
overrideprotectedvirtual

Verifies that the input images occupy the same physical space and the each index is at the same physical location.

The default implementation of the PropagateRequestedRegion methods copies the index and size from the output to the input. This makes an implicit assumption that the images occupy the same physical location at each voxel. This method enforces that they are the same.

This implementation verifies that all input images of InputImageDimensions have the same origin, spacing and direction.

Filters which do not expect all input images to be at the same physical location should over-ride this method. Also filters whose inputs are different dimensions may need to override this method.

See also
ProcessObject::VerifyInputInformation

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

◆ VerifyInputInformationOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::VerifyInputInformationOn ( )
virtual

Verify that the origin, spacing, and direction of both images match

Member Data Documentation

◆ m_DifferenceThreshold

template<typename TInputImage , typename TOutputImage >
OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_DifferenceThreshold
protected

Definition at line 145 of file itkTestingComparisonImageFilter.h.

◆ m_IgnoreBoundaryPixels

template<typename TInputImage , typename TOutputImage >
bool itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_IgnoreBoundaryPixels
private

Definition at line 165 of file itkTestingComparisonImageFilter.h.

◆ m_MaximumDifference

template<typename TInputImage , typename TOutputImage >
OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_MaximumDifference
protected

Definition at line 149 of file itkTestingComparisonImageFilter.h.

◆ m_MeanDifference

template<typename TInputImage , typename TOutputImage >
RealType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_MeanDifference
protected

Definition at line 147 of file itkTestingComparisonImageFilter.h.

◆ m_MinimumDifference

template<typename TInputImage , typename TOutputImage >
OutputPixelType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_MinimumDifference
protected

Definition at line 148 of file itkTestingComparisonImageFilter.h.

◆ m_NumberOfPixelsWithDifferences

template<typename TInputImage , typename TOutputImage >
SizeValueType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_NumberOfPixelsWithDifferences
protected

Definition at line 154 of file itkTestingComparisonImageFilter.h.

◆ m_ThreadDifferenceSum

template<typename TInputImage , typename TOutputImage >
Array<AccumulateType> itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadDifferenceSum
protected

Definition at line 158 of file itkTestingComparisonImageFilter.h.

◆ m_ThreadMaximumDifference

template<typename TInputImage , typename TOutputImage >
Array<OutputPixelType> itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadMaximumDifference
protected

Definition at line 162 of file itkTestingComparisonImageFilter.h.

◆ m_ThreadMinimumDifference

template<typename TInputImage , typename TOutputImage >
Array<OutputPixelType> itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadMinimumDifference
protected

Definition at line 161 of file itkTestingComparisonImageFilter.h.

◆ m_ThreadNumberOfPixels

template<typename TInputImage , typename TOutputImage >
Array<SizeValueType> itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ThreadNumberOfPixels
protected

Definition at line 159 of file itkTestingComparisonImageFilter.h.

◆ m_ToleranceRadius

template<typename TInputImage , typename TOutputImage >
int itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_ToleranceRadius
protected

Definition at line 156 of file itkTestingComparisonImageFilter.h.

◆ m_TotalDifference

template<typename TInputImage , typename TOutputImage >
AccumulateType itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_TotalDifference
protected

Definition at line 152 of file itkTestingComparisonImageFilter.h.

◆ m_VerifyInputInformation

template<typename TInputImage , typename TOutputImage >
bool itk::Testing::ComparisonImageFilter< TInputImage, TOutputImage >::m_VerifyInputInformation
protected

Definition at line 150 of file itkTestingComparisonImageFilter.h.


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