Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::DifferenceImageFilter< TInputImage, TOutputImage > Class Template Reference

Implements comparison between two images. More...

#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< SelfPointer
 
typedef itk::NumericTraits
< OutputPixelType >::RealType 
RealType
 
typedef RealType::RealValueType ScalarRealType
 
typedef DifferenceImageFilter Self
 
typedef
itk::ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual ScalarRealType GetDifferenceThreshold ()
 
virtual RealType GetMeanDifference ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned long GetNumberOfPixelsWithDifferences ()
 
virtual int GetToleranceRadius ()
 
virtual RealType GetTotalDifference ()
 
virtual void SetDifferenceThreshold (ScalarRealType _arg)
 
virtual void SetTestInput (const InputImageType *testImage)
 
virtual void SetToleranceRadius (int _arg)
 
virtual void SetValidInput (const InputImageType *validImage)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

 DifferenceImageFilter ()
 
virtual ~DifferenceImageFilter ()
 
void AfterThreadedGenerateData ()
 
void BeforeThreadedGenerateData ()
 
virtual void GenerateOutputInformation ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &threadRegion, itk::ThreadIdType threadId)
 

Protected Attributes

ScalarRealType m_DifferenceThreshold
 
RealType m_MeanDifference
 
unsigned long m_NumberOfPixelsWithDifferences
 
std::vector< RealTypem_ThreadDifferenceSum
 
itk::Array< unsigned long > m_ThreadNumberOfPixels
 
int m_ToleranceRadius
 
RealType m_TotalDifference
 

Private Member Functions

 DifferenceImageFilter (const Self &)
 
void operator= (const Self &)
 

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 23 of file otbDifferenceImageFilter.h.

Member Typedef Documentation

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

Definition at line 45 of file otbDifferenceImageFilter.h.

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

Definition at line 31 of file otbDifferenceImageFilter.h.

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

Some convenient typedefs.

Definition at line 37 of file otbDifferenceImageFilter.h.

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

Definition at line 43 of file otbDifferenceImageFilter.h.

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

Definition at line 41 of file otbDifferenceImageFilter.h.

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

Definition at line 42 of file otbDifferenceImageFilter.h.

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

Definition at line 30 of file otbDifferenceImageFilter.h.

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

Definition at line 44 of file otbDifferenceImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef RealType::RealValueType otb::DifferenceImageFilter< TInputImage, TOutputImage >::ScalarRealType

Definition at line 46 of file otbDifferenceImageFilter.h.

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

Standard class typedefs.

Definition at line 28 of file otbDifferenceImageFilter.h.

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

Definition at line 29 of file otbDifferenceImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
otb::DifferenceImageFilter< TInputImage, TOutputImage >::DifferenceImageFilter ( )
protected

Definition at line 19 of file otbDifferenceImageFilter.txx.

References itk::NumericTraits< T >::ZeroValue().

template<class TInputImage , class TOutputImage >
virtual otb::DifferenceImageFilter< TInputImage, TOutputImage >::~DifferenceImageFilter ( )
inlineprotectedvirtual

Definition at line 71 of file otbDifferenceImageFilter.h.

template<class TInputImage , class TOutputImage >
otb::DifferenceImageFilter< TInputImage, TOutputImage >::DifferenceImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage >
void otb::DifferenceImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData ( void  )
protected

Definition at line 245 of file otbDifferenceImageFilter.txx.

template<class TInputImage , class TOutputImage >
void otb::DifferenceImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
protected

Definition at line 90 of file otbDifferenceImageFilter.txx.

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::DifferenceImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage >
void otb::DifferenceImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( void  )
protectedvirtual

Definition at line 75 of file otbDifferenceImageFilter.txx.

template<class TInputImage , class TOutputImage >
virtual ScalarRealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetDifferenceThreshold ( )
virtual
template<class TInputImage , class TOutputImage >
virtual RealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetMeanDifference ( )
virtual

Get parameters of the difference image after execution.

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

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual unsigned long otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetNumberOfPixelsWithDifferences ( )
virtual
template<class TInputImage , class TOutputImage >
virtual int otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetToleranceRadius ( )
virtual
template<class TInputImage , class TOutputImage >
virtual RealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::GetTotalDifference ( )
virtual
template<class TInputImage , class TOutputImage >
static Pointer otb::DifferenceImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage >
void otb::DifferenceImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TOutputImage >
void otb::DifferenceImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 42 of file otbDifferenceImageFilter.txx.

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.

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 67 of file otbDifferenceImageFilter.txx.

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.

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 57 of file otbDifferenceImageFilter.txx.

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

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 118 of file otbDifferenceImageFilter.txx.

References itk::NumericTraits< T >::max().

Member Data Documentation

template<class TInputImage , class TOutputImage >
ScalarRealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_DifferenceThreshold
protected

Definition at line 93 of file otbDifferenceImageFilter.h.

template<class TInputImage , class TOutputImage >
RealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_MeanDifference
protected

Definition at line 94 of file otbDifferenceImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned long otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_NumberOfPixelsWithDifferences
protected

Definition at line 96 of file otbDifferenceImageFilter.h.

template<class TInputImage , class TOutputImage >
std::vector<RealType> otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_ThreadDifferenceSum
protected

Definition at line 99 of file otbDifferenceImageFilter.h.

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

Definition at line 100 of file otbDifferenceImageFilter.h.

template<class TInputImage , class TOutputImage >
int otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_ToleranceRadius
protected

Definition at line 97 of file otbDifferenceImageFilter.h.

template<class TInputImage , class TOutputImage >
RealType otb::DifferenceImageFilter< TInputImage, TOutputImage >::m_TotalDifference
protected

Definition at line 95 of file otbDifferenceImageFilter.h.


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