OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::PersistentCompareImageFilter< TInputImage > Class Template Reference
Processing images region by region » Filters supporting StreamingSupport for Multithreading » | Multithreaded FiltersGroup Core » | Module OTBStatistics

#include <otbStreamingCompareImageFilter.h>

+ Inheritance diagram for otb::PersistentCompareImageFilter< TInputImage >:
+ Collaboration diagram for otb::PersistentCompareImageFilter< TInputImage >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef itk::SimpleDataObjectDecorator< PixelType > PixelObjectType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SimpleDataObjectDecorator< RealType > RealObjectType
 
typedef itk::NumericTraits< PixelType >::RealType RealType
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentCompareImageFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef PersistentImageFilter< TInputImage, TInputImage > Superclass
 
- Public Types inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef TInputImage InputImageType
 
typedef TInputImage OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef PersistentImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TInputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
itk::Array< RealType > m_SquareOfDifferences
 
itk::Array< RealType > m_AbsoluteValueOfDifferences
 
itk::Array< PixelType > m_ThreadMinRef
 
itk::Array< PixelType > m_ThreadMaxRef
 
itk::Array< long > m_Count
 
itk::Array< long > m_DiffCount
 
bool m_PhysicalSpaceCheck
 
const TInputImage * GetInput1 ()
 
const TInputImage * GetInput2 ()
 
void SetInput1 (const TInputImage *image)
 
void SetInput2 (const TInputImage *image)
 
RealType GetPSNR () const
 
RealObjectType * GetPSNROutput ()
 
const RealObjectType * GetPSNROutput () const
 
RealType GetMSE () const
 
RealObjectType * GetMSEOutput ()
 
const RealObjectType * GetMSEOutput () const
 
RealType GetMAE () const
 
RealObjectType * GetMAEOutput ()
 
const RealObjectType * GetMAEOutput () const
 
RealType GetDiffCount () const
 
RealObjectType * GetDiffCountOutput ()
 
const RealObjectType * GetDiffCountOutput () const
 
virtual bool GetPhysicalSpaceCheck ()
 
virtual void SetPhysicalSpaceCheck (bool _arg)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 
void Synthetize (void) override
 
void Reset (void) override
 
 PersistentCompareImageFilter ()
 
 ~PersistentCompareImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void VerifyInputInformation () override
 
 PersistentCompareImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

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

Detailed Description

template<class TInputImage>
class otb::PersistentCompareImageFilter< TInputImage >

Compute mean squared error, mean absolute error and PSNR of two imagee using the output requested region.

This filter persists its temporary data. It means that if you Update it n times on n different requested regions, the output estimators will be the estimators of the whole set of n regions.

To reset the temporary data, one should call the Reset() function.

To get the estimators once the regions have been processed via the pipeline, use the Synthetize() method.

See also
PersistentImageFilter

Definition at line 51 of file otbStreamingCompareImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage >
typedef itk::SmartPointer<const Self> otb::PersistentCompareImageFilter< TInputImage >::ConstPointer

Definition at line 58 of file otbStreamingCompareImageFilter.h.

◆ DataObjectPointer

template<class TInputImage >
typedef itk::DataObject::Pointer otb::PersistentCompareImageFilter< TInputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 85 of file otbStreamingCompareImageFilter.h.

◆ DataObjectPointerArraySizeType

template<class TInputImage >
typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::PersistentCompareImageFilter< TInputImage >::DataObjectPointerArraySizeType

Definition at line 74 of file otbStreamingCompareImageFilter.h.

◆ ImageType

template<class TInputImage >
typedef TInputImage otb::PersistentCompareImageFilter< TInputImage >::ImageType

Image related typedefs.

Definition at line 64 of file otbStreamingCompareImageFilter.h.

◆ IndexType

template<class TInputImage >
typedef TInputImage::IndexType otb::PersistentCompareImageFilter< TInputImage >::IndexType

Definition at line 72 of file otbStreamingCompareImageFilter.h.

◆ InputImagePointer

template<class TInputImage >
typedef TInputImage::Pointer otb::PersistentCompareImageFilter< TInputImage >::InputImagePointer

Definition at line 68 of file otbStreamingCompareImageFilter.h.

◆ PixelObjectType

template<class TInputImage >
typedef itk::SimpleDataObjectDecorator<PixelType> otb::PersistentCompareImageFilter< TInputImage >::PixelObjectType

Definition at line 89 of file otbStreamingCompareImageFilter.h.

◆ PixelType

template<class TInputImage >
typedef TInputImage::PixelType otb::PersistentCompareImageFilter< TInputImage >::PixelType

Definition at line 73 of file otbStreamingCompareImageFilter.h.

◆ Pointer

template<class TInputImage >
typedef itk::SmartPointer<Self> otb::PersistentCompareImageFilter< TInputImage >::Pointer

Definition at line 57 of file otbStreamingCompareImageFilter.h.

◆ RealObjectType

template<class TInputImage >
typedef itk::SimpleDataObjectDecorator<RealType> otb::PersistentCompareImageFilter< TInputImage >::RealObjectType

Type of DataObjects used for scalar outputs

Definition at line 88 of file otbStreamingCompareImageFilter.h.

◆ RealType

template<class TInputImage >
typedef itk::NumericTraits<PixelType>::RealType otb::PersistentCompareImageFilter< TInputImage >::RealType

Type to use for computations.

Definition at line 82 of file otbStreamingCompareImageFilter.h.

◆ RegionType

template<class TInputImage >
typedef TInputImage::RegionType otb::PersistentCompareImageFilter< TInputImage >::RegionType

Definition at line 70 of file otbStreamingCompareImageFilter.h.

◆ Self

template<class TInputImage >
typedef PersistentCompareImageFilter otb::PersistentCompareImageFilter< TInputImage >::Self

Standard Self typedef

Definition at line 55 of file otbStreamingCompareImageFilter.h.

◆ SizeType

template<class TInputImage >
typedef TInputImage::SizeType otb::PersistentCompareImageFilter< TInputImage >::SizeType

Definition at line 71 of file otbStreamingCompareImageFilter.h.

◆ Superclass

template<class TInputImage >
typedef PersistentImageFilter<TInputImage, TInputImage> otb::PersistentCompareImageFilter< TInputImage >::Superclass

Definition at line 56 of file otbStreamingCompareImageFilter.h.

Constructor & Destructor Documentation

◆ PersistentCompareImageFilter() [1/2]

template<class TInputImage >
otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter
protected

Get the inputs

Definition at line 34 of file otbStreamingCompareImageFilter.hxx.

References otb::PersistentCompareImageFilter< TInputImage >::GetDiffCountOutput(), otb::PersistentCompareImageFilter< TInputImage >::GetMAEOutput(), otb::PersistentCompareImageFilter< TInputImage >::GetMSEOutput(), otb::PersistentCompareImageFilter< TInputImage >::GetPSNROutput(), otb::PersistentCompareImageFilter< TInputImage >::MakeOutput(), and otb::PersistentCompareImageFilter< TInputImage >::Reset().

◆ ~PersistentCompareImageFilter()

template<class TInputImage >
otb::PersistentCompareImageFilter< TInputImage >::~PersistentCompareImageFilter ( )
inlineoverrideprotected

Get the inputs

Definition at line 157 of file otbStreamingCompareImageFilter.h.

◆ PersistentCompareImageFilter() [2/2]

template<class TInputImage >
otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter ( const Self &  )
privatedelete

Get the inputs

Member Function Documentation

◆ AllocateOutputs()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::AllocateOutputs
override

Pass the input through unmodified. Do this by Grafting in the AllocateOutputs method.

Definition at line 182 of file otbStreamingCompareImageFilter.hxx.

◆ CreateAnother()

template<class TInputImage >
virtual::itk::LightObject::Pointer otb::PersistentCompareImageFilter< TInputImage >::CreateAnother ( void  ) const

◆ GenerateOutputInformation()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::GenerateOutputInformation
override

Get the inputs

Definition at line 167 of file otbStreamingCompareImageFilter.hxx.

◆ GetDiffCount()

template<class TInputImage >
RealType otb::PersistentCompareImageFilter< TInputImage >::GetDiffCount ( ) const
inline

Return the Number of Pixel which are different.

Definition at line 130 of file otbStreamingCompareImageFilter.h.

◆ GetDiffCountOutput() [1/2]

template<class TInputImage >
const PersistentCompareImageFilter< TInputImage >::RealObjectType * otb::PersistentCompareImageFilter< TInputImage >::GetDiffCountOutput

Get the inputs

Definition at line 155 of file otbStreamingCompareImageFilter.hxx.

Referenced by otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter().

◆ GetDiffCountOutput() [2/2]

template<class TInputImage >
const RealObjectType* otb::PersistentCompareImageFilter< TInputImage >::GetDiffCountOutput ( ) const

Get the inputs

◆ GetInput1()

template<class TInputImage >
const TInputImage * otb::PersistentCompareImageFilter< TInputImage >::GetInput1

Get the inputs

Definition at line 78 of file otbStreamingCompareImageFilter.hxx.

◆ GetInput2()

template<class TInputImage >
const TInputImage * otb::PersistentCompareImageFilter< TInputImage >::GetInput2

Get the inputs

Definition at line 88 of file otbStreamingCompareImageFilter.hxx.

◆ GetMAE()

template<class TInputImage >
RealType otb::PersistentCompareImageFilter< TInputImage >::GetMAE ( ) const
inline

Return the computed MAE.

Definition at line 121 of file otbStreamingCompareImageFilter.h.

◆ GetMAEOutput() [1/2]

template<class TInputImage >
const PersistentCompareImageFilter< TInputImage >::RealObjectType * otb::PersistentCompareImageFilter< TInputImage >::GetMAEOutput

Get the inputs

Definition at line 143 of file otbStreamingCompareImageFilter.hxx.

Referenced by otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter().

◆ GetMAEOutput() [2/2]

template<class TInputImage >
const RealObjectType* otb::PersistentCompareImageFilter< TInputImage >::GetMAEOutput ( ) const

Get the inputs

◆ GetMSE()

template<class TInputImage >
RealType otb::PersistentCompareImageFilter< TInputImage >::GetMSE ( ) const
inline

Return the computed MSE.

Definition at line 112 of file otbStreamingCompareImageFilter.h.

◆ GetMSEOutput() [1/2]

template<class TInputImage >
const PersistentCompareImageFilter< TInputImage >::RealObjectType * otb::PersistentCompareImageFilter< TInputImage >::GetMSEOutput

Get the inputs

Definition at line 131 of file otbStreamingCompareImageFilter.hxx.

Referenced by otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter().

◆ GetMSEOutput() [2/2]

template<class TInputImage >
const RealObjectType* otb::PersistentCompareImageFilter< TInputImage >::GetMSEOutput ( ) const

Get the inputs

◆ GetNameOfClass()

template<class TInputImage >
virtual const char* otb::PersistentCompareImageFilter< TInputImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

◆ GetPhysicalSpaceCheck()

template<class TInputImage >
virtual bool otb::PersistentCompareImageFilter< TInputImage >::GetPhysicalSpaceCheck ( )
virtual

Get the inputs

◆ GetPSNR()

template<class TInputImage >
RealType otb::PersistentCompareImageFilter< TInputImage >::GetPSNR ( ) const
inline

Return the computed PSNR.

Definition at line 103 of file otbStreamingCompareImageFilter.h.

◆ GetPSNROutput() [1/2]

template<class TInputImage >
const PersistentCompareImageFilter< TInputImage >::RealObjectType * otb::PersistentCompareImageFilter< TInputImage >::GetPSNROutput

Get the inputs

Definition at line 119 of file otbStreamingCompareImageFilter.hxx.

Referenced by otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter().

◆ GetPSNROutput() [2/2]

template<class TInputImage >
const RealObjectType* otb::PersistentCompareImageFilter< TInputImage >::GetPSNROutput ( ) const

Get the inputs

◆ MakeOutput()

template<class TInputImage >
itk::DataObject::Pointer otb::PersistentCompareImageFilter< TInputImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)
override

Make a DataObject of the correct type to be used as the specified output.

Definition at line 98 of file otbStreamingCompareImageFilter.hxx.

Referenced by otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter().

◆ New()

template<class TInputImage >
static Pointer otb::PersistentCompareImageFilter< TInputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::operator= ( const Self &  )
privatedelete

Get the inputs

◆ PrintSelf()

template<class TImage >
void otb::PersistentCompareImageFilter< TImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Get the inputs

Definition at line 330 of file otbStreamingCompareImageFilter.hxx.

◆ Reset()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::Reset ( void  )
overridevirtual

Get the inputs

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 248 of file otbStreamingCompareImageFilter.hxx.

Referenced by otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter().

◆ SetInput1()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::SetInput1 ( const TInputImage *  image)

Connect one the first operands.

Connect one of the first operand

Definition at line 61 of file otbStreamingCompareImageFilter.hxx.

◆ SetInput2()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::SetInput2 ( const TInputImage *  image)

Connect one the second operands.

Connect one of the second operand

Definition at line 71 of file otbStreamingCompareImageFilter.hxx.

◆ SetPhysicalSpaceCheck()

template<class TInputImage >
virtual void otb::PersistentCompareImageFilter< TInputImage >::SetPhysicalSpaceCheck ( bool  _arg)
virtual

Get the inputs

◆ Synthetize()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::Synthetize ( void  )
overridevirtual

Get the inputs

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 192 of file otbStreamingCompareImageFilter.hxx.

◆ ThreadedGenerateData()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Multi-thread version GenerateData.

Grab the input

Definition at line 278 of file otbStreamingCompareImageFilter.hxx.

◆ VerifyInputInformation()

template<class TInputImage >
void otb::PersistentCompareImageFilter< TInputImage >::VerifyInputInformation
overrideprotected

Allows skipping the verification of physical space between the two input images (see flag m_PhysicalSpaceCheck)

Definition at line 271 of file otbStreamingCompareImageFilter.hxx.

Member Data Documentation

◆ ImageDimension

template<class TInputImage >
const unsigned int otb::PersistentCompareImageFilter< TInputImage >::ImageDimension = TInputImage::ImageDimension
static

Image related typedefs.

Definition at line 79 of file otbStreamingCompareImageFilter.h.

◆ InputImageDimension

template<class TInputImage >
const unsigned int otb::PersistentCompareImageFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension
static

Definition at line 76 of file otbStreamingCompareImageFilter.h.

◆ m_AbsoluteValueOfDifferences

template<class TInputImage >
itk::Array<RealType> otb::PersistentCompareImageFilter< TInputImage >::m_AbsoluteValueOfDifferences
private

Get the inputs

Definition at line 175 of file otbStreamingCompareImageFilter.h.

◆ m_Count

template<class TInputImage >
itk::Array<long> otb::PersistentCompareImageFilter< TInputImage >::m_Count
private

Get the inputs

Definition at line 178 of file otbStreamingCompareImageFilter.h.

◆ m_DiffCount

template<class TInputImage >
itk::Array<long> otb::PersistentCompareImageFilter< TInputImage >::m_DiffCount
private

Get the inputs

Definition at line 179 of file otbStreamingCompareImageFilter.h.

◆ m_PhysicalSpaceCheck

template<class TInputImage >
bool otb::PersistentCompareImageFilter< TInputImage >::m_PhysicalSpaceCheck
private

Get the inputs

Definition at line 180 of file otbStreamingCompareImageFilter.h.

◆ m_SquareOfDifferences

template<class TInputImage >
itk::Array<RealType> otb::PersistentCompareImageFilter< TInputImage >::m_SquareOfDifferences
private

Get the inputs

Definition at line 174 of file otbStreamingCompareImageFilter.h.

◆ m_ThreadMaxRef

template<class TInputImage >
itk::Array<PixelType> otb::PersistentCompareImageFilter< TInputImage >::m_ThreadMaxRef
private

Get the inputs

Definition at line 177 of file otbStreamingCompareImageFilter.h.

◆ m_ThreadMinRef

template<class TInputImage >
itk::Array<PixelType> otb::PersistentCompareImageFilter< TInputImage >::m_ThreadMinRef
private

Get the inputs

Definition at line 176 of file otbStreamingCompareImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:19 for OTB with   doxygen 1.8.17