OTB  7.2.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members

#include <otbStreamingCompareImageFilter.h>

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

Public Types

typedef Superclass::FilterType CompareFilterType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef TInputImage InputImageType
 
typedef itk::SimpleDataObjectDecorator< PixelTypePixelObjectType
 
typedef CompareFilterType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SimpleDataObjectDecorator< RealTypeRealObjectType
 
typedef CompareFilterType::RealType RealType
 
typedef StreamingCompareImageFilter Self
 
typedef PersistentFilterStreamingDecorator< PersistentCompareImageFilter< TInputImage > > Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentCompareImageFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentCompareImageFilter< TInputImage > FilterType
 
typedef FilterType::InputImageType ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PersistentFilterStreamingDecorator Self
 
typedef StreamerType::Pointer StreamerPointerType
 
typedef StreamingImageVirtualWriter< ImageTypeStreamerType
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
bool GetPhysicalSpaceCheck ()
 
void SetInput1 (InputImageType *input)
 
void SetInput2 (InputImageType *input)
 
void SetPhysicalSpaceCheck (bool flag)
 
RealType GetPSNR () const
 
RealObjectTypeGetPSNROutput ()
 
const RealObjectTypeGetPSNROutput () const
 
RealType GetMSE () const
 
RealObjectTypeGetMSEOutput ()
 
const RealObjectTypeGetMSEOutput () const
 
RealType GetMAE () const
 
RealObjectTypeGetMAEOutput ()
 
const RealObjectTypeGetMAEOutput () const
 
RealType GetDiffCount () const
 
RealObjectTypeGetDiffCountOutput ()
 
const RealObjectTypeGetDiffCountOutput () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentCompareImageFilter< TInputImage > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const FilterTypeGetFilter () const
 
 itkGetObjectMacro (Filter, FilterType)
 
 itkGetObjectMacro (Streamer, StreamerType)
 
virtual void SetFilter (FilterType *_arg)
 
void Update (void) override
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentCompareImageFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

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

Private Member Functions

void operator= (const Self &)=delete
 
 StreamingCompareImageFilter (const Self &)=delete
 

Additional Inherited Members

- Protected Attributes inherited from otb::PersistentFilterStreamingDecorator< PersistentCompareImageFilter< TInputImage > >
FilterPointerType m_Filter
 
StreamerPointerType m_Streamer
 

Detailed Description

template<class TInputImage>
class otb::StreamingCompareImageFilter< TInputImage >

This class streams the whole input image through the PersistentCompareImageFilter.

This way, it allows computing estimator on two images. It calls the Reset() method of the PersistentCompareImageFilter before streaming the image and the Synthetize() method of the PersistentCompareImageFilter after having streamed the image to compute the estimators. The accessor on the results are wrapping the accessors of the internal PersistentCompareImageFilter.

This filter can be used as:

CompareType::Pointer estimators = CompareType::New();
estimators->SetInput(reader->GetOutput());
estimators->Update();
std::cout << estimators-> GetMSE() << std::endl;
std::cout << estimators-> GetPSNR() << std::endl;
See also
PersistentCompareImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 215 of file otbStreamingCompareImageFilter.h.

Member Typedef Documentation

◆ CompareFilterType

template<class TInputImage >
typedef Superclass::FilterType otb::StreamingCompareImageFilter< TInputImage >::CompareFilterType

Definition at line 228 of file otbStreamingCompareImageFilter.h.

◆ ConstPointer

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

Definition at line 222 of file otbStreamingCompareImageFilter.h.

◆ InputImageType

template<class TInputImage >
typedef TInputImage otb::StreamingCompareImageFilter< TInputImage >::InputImageType

Definition at line 233 of file otbStreamingCompareImageFilter.h.

◆ PixelObjectType

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

Definition at line 237 of file otbStreamingCompareImageFilter.h.

◆ PixelType

template<class TInputImage >
typedef CompareFilterType::PixelType otb::StreamingCompareImageFilter< TInputImage >::PixelType

Definition at line 231 of file otbStreamingCompareImageFilter.h.

◆ Pointer

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

Definition at line 221 of file otbStreamingCompareImageFilter.h.

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 236 of file otbStreamingCompareImageFilter.h.

◆ RealType

template<class TInputImage >
typedef CompareFilterType::RealType otb::StreamingCompareImageFilter< TInputImage >::RealType

Definition at line 232 of file otbStreamingCompareImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 219 of file otbStreamingCompareImageFilter.h.

◆ Superclass

template<class TInputImage >
typedef PersistentFilterStreamingDecorator<PersistentCompareImageFilter<TInputImage> > otb::StreamingCompareImageFilter< TInputImage >::Superclass

Definition at line 220 of file otbStreamingCompareImageFilter.h.

Constructor & Destructor Documentation

◆ StreamingCompareImageFilter() [1/2]

template<class TInputImage >
otb::StreamingCompareImageFilter< TInputImage >::StreamingCompareImageFilter ( )
inlineprotected

Constructor

Definition at line 325 of file otbStreamingCompareImageFilter.h.

◆ ~StreamingCompareImageFilter()

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

Destructor

Definition at line 328 of file otbStreamingCompareImageFilter.h.

◆ StreamingCompareImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetDiffCount()

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

Return the Number of Pixel different.

Definition at line 297 of file otbStreamingCompareImageFilter.h.

◆ GetDiffCountOutput() [1/2]

template<class TInputImage >
RealObjectType* otb::StreamingCompareImageFilter< TInputImage >::GetDiffCountOutput ( )
inline

Return the Number of Pixel different.

Definition at line 301 of file otbStreamingCompareImageFilter.h.

◆ GetDiffCountOutput() [2/2]

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

Return the Number of Pixel different.

Definition at line 305 of file otbStreamingCompareImageFilter.h.

◆ GetMAE()

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

Return the computed MAE.

Definition at line 282 of file otbStreamingCompareImageFilter.h.

◆ GetMAEOutput() [1/2]

template<class TInputImage >
RealObjectType* otb::StreamingCompareImageFilter< TInputImage >::GetMAEOutput ( )
inline

Return the computed MAE.

Definition at line 286 of file otbStreamingCompareImageFilter.h.

◆ GetMAEOutput() [2/2]

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

Return the computed MAE.

Definition at line 290 of file otbStreamingCompareImageFilter.h.

◆ GetMSE()

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

Return the computed MSE.

Definition at line 267 of file otbStreamingCompareImageFilter.h.

◆ GetMSEOutput() [1/2]

template<class TInputImage >
RealObjectType* otb::StreamingCompareImageFilter< TInputImage >::GetMSEOutput ( )
inline

Return the computed MSE.

Definition at line 271 of file otbStreamingCompareImageFilter.h.

◆ GetMSEOutput() [2/2]

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

Return the computed MSE.

Definition at line 275 of file otbStreamingCompareImageFilter.h.

◆ GetNameOfClass()

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

Creation through object factory macro

Reimplemented from otb::PersistentFilterStreamingDecorator< PersistentCompareImageFilter< TInputImage > >.

◆ GetPhysicalSpaceCheck()

template<class TInputImage >
bool otb::StreamingCompareImageFilter< TInputImage >::GetPhysicalSpaceCheck ( )
inline

Get the PhysicalSpaceCheck flag

Definition at line 318 of file otbStreamingCompareImageFilter.h.

◆ GetPSNR()

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

Return the computed PSNR.

Definition at line 252 of file otbStreamingCompareImageFilter.h.

◆ GetPSNROutput() [1/2]

template<class TInputImage >
RealObjectType* otb::StreamingCompareImageFilter< TInputImage >::GetPSNROutput ( )
inline

Return the computed PSNR.

Definition at line 256 of file otbStreamingCompareImageFilter.h.

◆ GetPSNROutput() [2/2]

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

Return the computed PSNR.

Definition at line 260 of file otbStreamingCompareImageFilter.h.

◆ New()

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

Type macro

◆ operator=()

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

◆ SetInput1()

template<class TInputImage >
void otb::StreamingCompareImageFilter< TInputImage >::SetInput1 ( InputImageType input)
inline

Connect one the first operands.

Definition at line 240 of file otbStreamingCompareImageFilter.h.

◆ SetInput2()

template<class TInputImage >
void otb::StreamingCompareImageFilter< TInputImage >::SetInput2 ( InputImageType input)
inline

Connect one the second operands.

Definition at line 246 of file otbStreamingCompareImageFilter.h.

◆ SetPhysicalSpaceCheck()

template<class TInputImage >
void otb::StreamingCompareImageFilter< TInputImage >::SetPhysicalSpaceCheck ( bool  flag)
inline

Set the PhysicalSpaceCheck flag

Definition at line 312 of file otbStreamingCompareImageFilter.h.


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