otb::DifferenceImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbDifferenceImageFilter.h>

Inheritance diagram for otb::DifferenceImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for otb::DifferenceImageFilter< TInputImage, TOutputImage >:

Public Types
typedef itk::NumericTraits< RealType >::AccumulateType	AccumulateType
typedef itk::SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef OutputImageType::PixelType	OutputPixelType
typedef itk::SmartPointer< Self >	Pointer
typedef itk::NumericTraits< OutputPixelType >::RealType	RealType
typedef itk::NumericTraits< OutputPixelType >::ScalarRealType	ScalarRealType
typedef DifferenceImageFilter	Self
typedef itk::ImageToImageFilter< TInputImage, TOutputImage >	Superclass
Public Types inherited from otb::PersistentImageFilter< TInputImage, TOutputImage >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef PersistentImageFilter	Self
typedef itk::ImageToImageFilter< TInputImage, 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)

Static Public Member Functions
static Pointer	New ()
ScalarRealType	m_DifferenceThreshold
RealType	m_MeanDifference
AccumulateType	m_TotalDifference
unsigned long	m_NumberOfPixelsWithDifferences
int	m_ToleranceRadius
std::vector< AccumulateType >	m_ThreadDifferenceSum
itk::Array< unsigned long >	m_ThreadNumberOfPixels
virtual void	SetToleranceRadius (int _arg)
virtual int	GetToleranceRadius ()
virtual void	SetDifferenceThreshold (ScalarRealType _arg)
virtual ScalarRealType	GetDifferenceThreshold ()
virtual RealType	GetMeanDifference ()
virtual AccumulateType	GetTotalDifference ()
virtual unsigned long	GetNumberOfPixelsWithDifferences ()
void	Synthetize (void) override
void	Reset (void) override
	DifferenceImageFilter ()
	~DifferenceImageFilter ()=default
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	ThreadedGenerateData (const OutputImageRegionType &threadRegion, itk::ThreadIdType threadId) override
void	GenerateOutputInformation () override
	DifferenceImageFilter (const Self &)=delete
void	operator= (const Self &)=delete

Additional Inherited Members
Protected Member Functions inherited from otb::PersistentImageFilter< TInputImage, TOutputImage >
	PersistentImageFilter ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~PersistentImageFilter () override

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::DifferenceImageFilter< 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 45 of file otbDifferenceImageFilter.h.

Member Typedef Documentation

AccumulateType

template<class TInputImage , class TOutputImage >

typedef itk::NumericTraits<RealType>::AccumulateType otb::DifferenceImageFilter< TInputImage, TOutputImage >::AccumulateType

Definition at line 66 of file otbDifferenceImageFilter.h.

ConstPointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<const Self> otb::DifferenceImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 52 of file otbDifferenceImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage >

typedef TInputImage otb::DifferenceImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 58 of file otbDifferenceImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType otb::DifferenceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 64 of file otbDifferenceImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage >

typedef TOutputImage otb::DifferenceImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 62 of file otbDifferenceImageFilter.h.

OutputPixelType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType otb::DifferenceImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 63 of file otbDifferenceImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<Self> otb::DifferenceImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 51 of file otbDifferenceImageFilter.h.

RealType

template<class TInputImage , class TOutputImage >

typedef itk::NumericTraits<OutputPixelType>::RealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::RealType

Definition at line 65 of file otbDifferenceImageFilter.h.

ScalarRealType

template<class TInputImage , class TOutputImage >

typedef itk::NumericTraits<OutputPixelType>::ScalarRealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::ScalarRealType

Definition at line 67 of file otbDifferenceImageFilter.h.

Self

template<class TInputImage , class TOutputImage >

typedef DifferenceImageFilter otb::DifferenceImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 49 of file otbDifferenceImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage >

typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::DifferenceImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 50 of file otbDifferenceImageFilter.h.

Constructor & Destructor Documentation

DifferenceImageFilter() [1/2]

template<class TInputImage , class TOutputImage >

otb::DifferenceImageFilter< TInputImage, TOutputImage >::DifferenceImageFilter

protected

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

Definition at line 37 of file otbDifferenceImageFilter.hxx.

References otb::mpl::GetNumberOfComponents().

~DifferenceImageFilter()

template<class TInputImage , class TOutputImage >

otb::DifferenceImageFilter< TInputImage, TOutputImage >::~DifferenceImageFilter ( )

protecteddefault

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

DifferenceImageFilter() [2/2]

template<class TInputImage , class TOutputImage >

otb::DifferenceImageFilter< TInputImage, TOutputImage >::DifferenceImageFilter ( const Self &  )

privatedelete

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

Member Function Documentation

CreateAnother()

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer otb::DifferenceImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

const

GenerateOutputInformation()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation

overrideprotected

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

Definition at line 86 of file otbDifferenceImageFilter.hxx.

GetDifferenceThreshold()

template<class TInputImage , class TOutputImage >

virtual ScalarRealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetDifferenceThreshold ( )

virtual

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

GetMeanDifference()

template<class TInputImage , class TOutputImage >

virtual RealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetMeanDifference ( )

virtual

Get parameters of the difference image after execution.

GetNameOfClass()

template<class TInputImage , class TOutputImage >

virtual const char* otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from otb::PersistentImageFilter< TInputImage, TOutputImage >.

GetNumberOfPixelsWithDifferences()

template<class TInputImage , class TOutputImage >

virtual unsigned long otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetNumberOfPixelsWithDifferences ( )

virtual

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

GetToleranceRadius()

template<class TInputImage , class TOutputImage >

virtual int otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetToleranceRadius ( )

virtual

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

GetTotalDifference()

template<class TInputImage , class TOutputImage >

virtual AccumulateType otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetTotalDifference ( )

virtual

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

New()

template<class TInputImage , class TOutputImage >

static Pointer otb::DifferenceImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

privatedelete

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

PrintSelf()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

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

Definition at line 59 of file otbDifferenceImageFilter.hxx.

Reset()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::Reset ( void  )

overridevirtual

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

Implements otb::PersistentImageFilter< TInputImage, TOutputImage >.

Definition at line 98 of file otbDifferenceImageFilter.hxx.

SetDifferenceThreshold()

template<class TInputImage , class TOutputImage >

virtual void otb::DifferenceImageFilter< TInputImage, TOutputImage >::SetDifferenceThreshold ( ScalarRealType  _arg )

virtual

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

SetTestInput()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::SetTestInput ( const InputImageType *  testImage )

virtual

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

Definition at line 79 of file otbDifferenceImageFilter.hxx.

SetToleranceRadius()

template<class TInputImage , class TOutputImage >

virtual void otb::DifferenceImageFilter< TInputImage, TOutputImage >::SetToleranceRadius ( int  _arg )

virtual

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

SetValidInput()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::SetValidInput ( const InputImageType *  validImage )

virtual

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

Definition at line 71 of file otbDifferenceImageFilter.hxx.

Synthetize()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::Synthetize ( void  )

overridevirtual

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

Implements otb::PersistentImageFilter< TInputImage, TOutputImage >.

Definition at line 263 of file otbDifferenceImageFilter.hxx.

ThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::DifferenceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  threadRegion, itk::ThreadIdType  threadId  )

overrideprotected

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

See also

ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Definition at line 126 of file otbDifferenceImageFilter.hxx.

Member Data Documentation

m_DifferenceThreshold

template<class TInputImage , class TOutputImage >

ScalarRealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_DifferenceThreshold

protected

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

Definition at line 117 of file otbDifferenceImageFilter.h.

m_MeanDifference

template<class TInputImage , class TOutputImage >

RealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_MeanDifference

protected

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

Definition at line 118 of file otbDifferenceImageFilter.h.

m_NumberOfPixelsWithDifferences

template<class TInputImage , class TOutputImage >

unsigned long otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_NumberOfPixelsWithDifferences

protected

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

Definition at line 120 of file otbDifferenceImageFilter.h.

m_ThreadDifferenceSum

template<class TInputImage , class TOutputImage >

std::vector<AccumulateType> otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_ThreadDifferenceSum

protected

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

Definition at line 123 of file otbDifferenceImageFilter.h.

m_ThreadNumberOfPixels

template<class TInputImage , class TOutputImage >

itk::Array<unsigned long> otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_ThreadNumberOfPixels

protected

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

Definition at line 124 of file otbDifferenceImageFilter.h.

m_ToleranceRadius

template<class TInputImage , class TOutputImage >

int otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_ToleranceRadius

protected

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

Definition at line 121 of file otbDifferenceImageFilter.h.

m_TotalDifference

template<class TInputImage , class TOutputImage >

AccumulateType otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_TotalDifference

protected

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

Definition at line 119 of file otbDifferenceImageFilter.h.

---

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

• otbDifferenceImageFilter.h
• otbDifferenceImageFilter.hxx