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

#include <otbStreamingStatisticsImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef itk::SimpleDataObjectDecorator< PixelTypePixelObjectType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SimpleDataObjectDecorator< RealTypeRealObjectType
 
typedef itk::NumericTraits< PixelType >::RealType RealType
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentStatisticsImageFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef PersistentImageFilter< TInputImage, TInputImage > Superclass
 
- Public Types inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef TInputImage InputImageType
 
typedef TInputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PersistentImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TInputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual bool GetIgnoreInfiniteValues ()
 
virtual bool GetIgnoreUserDefinedValue ()
 
virtual const char * GetNameOfClass () const
 
virtual RealType GetUserIgnoredValue ()
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
virtual void SetIgnoreInfiniteValues (bool _arg)
 
virtual void SetIgnoreUserDefinedValue (bool _arg)
 
virtual void SetUserIgnoredValue (RealType _arg)
 
PixelType GetMinimum () const
 
PixelObjectTypeGetMinimumOutput ()
 
const PixelObjectTypeGetMinimumOutput () const
 
PixelType GetMaximum () const
 
PixelObjectTypeGetMaximumOutput ()
 
const PixelObjectTypeGetMaximumOutput () const
 
RealType GetMean () const
 
RealObjectTypeGetMeanOutput ()
 
const RealObjectTypeGetMeanOutput () const
 
RealType GetSigma () const
 
RealObjectTypeGetSigmaOutput ()
 
const RealObjectTypeGetSigmaOutput () const
 
RealType GetVariance () const
 
RealObjectTypeGetVarianceOutput ()
 
const RealObjectTypeGetVarianceOutput () const
 
RealType GetSum () const
 
RealObjectTypeGetSumOutput ()
 
const RealObjectTypeGetSumOutput () const
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 
void Synthetize (void) override
 
void Reset (void) override
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Member Functions

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

Private Member Functions

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

Private Attributes

itk::Array< long > m_Count
 
std::vector< unsigned int > m_IgnoredInfinitePixelCount
 
std::vector< unsigned int > m_IgnoredUserPixelCount
 
bool m_IgnoreInfiniteValues
 
bool m_IgnoreUserDefinedValue
 
itk::Array< RealTypem_SumOfSquares
 
itk::Array< PixelTypem_ThreadMax
 
itk::Array< PixelTypem_ThreadMin
 
itk::Array< RealTypem_ThreadSum
 
RealType m_UserIgnoredValue
 

Detailed Description

template<class TInputImage>
class otb::PersistentStatisticsImageFilter< TInputImage >

Compute min. max, variance and mean of an image 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 statistics will be the statitics of the whole set of n regions.

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

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

See also
PersistentImageFilter

Definition at line 52 of file otbStreamingStatisticsImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 59 of file otbStreamingStatisticsImageFilter.h.

◆ DataObjectPointer

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

Smart Pointer type to a DataObject.

Definition at line 85 of file otbStreamingStatisticsImageFilter.h.

◆ DataObjectPointerArraySizeType

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

Definition at line 86 of file otbStreamingStatisticsImageFilter.h.

◆ ImageType

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

Image related typedefs.

Definition at line 65 of file otbStreamingStatisticsImageFilter.h.

◆ IndexType

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

Definition at line 73 of file otbStreamingStatisticsImageFilter.h.

◆ InputImagePointer

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

Definition at line 69 of file otbStreamingStatisticsImageFilter.h.

◆ PixelObjectType

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

Definition at line 90 of file otbStreamingStatisticsImageFilter.h.

◆ PixelType

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

Definition at line 74 of file otbStreamingStatisticsImageFilter.h.

◆ Pointer

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

Definition at line 58 of file otbStreamingStatisticsImageFilter.h.

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 89 of file otbStreamingStatisticsImageFilter.h.

◆ RealType

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

Type to use for computations.

Definition at line 82 of file otbStreamingStatisticsImageFilter.h.

◆ RegionType

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

Definition at line 71 of file otbStreamingStatisticsImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 56 of file otbStreamingStatisticsImageFilter.h.

◆ SizeType

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

Definition at line 72 of file otbStreamingStatisticsImageFilter.h.

◆ Superclass

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

Definition at line 57 of file otbStreamingStatisticsImageFilter.h.

Constructor & Destructor Documentation

◆ PersistentStatisticsImageFilter() [1/2]

template<class TInputImage >
otb::PersistentStatisticsImageFilter< TInputImage >::PersistentStatisticsImageFilter ( )
protected

◆ ~PersistentStatisticsImageFilter()

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

Definition at line 171 of file otbStreamingStatisticsImageFilter.h.

◆ PersistentStatisticsImageFilter() [2/2]

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

Member Function Documentation

◆ AllocateOutputs()

template<class TInputImage >
void otb::PersistentStatisticsImageFilter< TInputImage >::AllocateOutputs ( )
override

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

Definition at line 183 of file otbStreamingStatisticsImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage >
void otb::PersistentStatisticsImageFilter< TInputImage >::GenerateOutputInformation ( void  )
override

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

Definition at line 168 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetIgnoreInfiniteValues()

template<class TInputImage>
virtual bool otb::PersistentStatisticsImageFilter< TInputImage >::GetIgnoreInfiniteValues ( )
virtual

◆ GetIgnoreUserDefinedValue()

template<class TInputImage>
virtual bool otb::PersistentStatisticsImageFilter< TInputImage >::GetIgnoreUserDefinedValue ( )
virtual

◆ GetMaximum()

template<class TInputImage>
PixelType otb::PersistentStatisticsImageFilter< TInputImage >::GetMaximum ( ) const
inline

Return the computed Maximum.

Definition at line 102 of file otbStreamingStatisticsImageFilter.h.

Referenced by otb::PersistentStatisticsImageFilter< TInputImage >::PrintSelf().

◆ GetMaximumOutput() [1/2]

template<class TInputImage >
PersistentStatisticsImageFilter< TInputImage >::PixelObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetMaximumOutput ( )

◆ GetMaximumOutput() [2/2]

template<class TInputImage >
const PersistentStatisticsImageFilter< TInputImage >::PixelObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetMaximumOutput ( ) const

Return the computed Maximum.

Definition at line 115 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetMean()

template<class TInputImage>
RealType otb::PersistentStatisticsImageFilter< TInputImage >::GetMean ( ) const
inline

Return the computed Mean.

Definition at line 111 of file otbStreamingStatisticsImageFilter.h.

Referenced by otb::PersistentStatisticsImageFilter< TInputImage >::PrintSelf().

◆ GetMeanOutput() [1/2]

template<class TInputImage >
PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetMeanOutput ( )

◆ GetMeanOutput() [2/2]

template<class TInputImage >
const PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetMeanOutput ( ) const

Return the computed Mean.

Definition at line 127 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetMinimum()

template<class TInputImage>
PixelType otb::PersistentStatisticsImageFilter< TInputImage >::GetMinimum ( ) const
inline

Return the computed Minimum.

Definition at line 93 of file otbStreamingStatisticsImageFilter.h.

Referenced by otb::PersistentStatisticsImageFilter< TInputImage >::PrintSelf().

◆ GetMinimumOutput() [1/2]

template<class TInputImage >
PersistentStatisticsImageFilter< TInputImage >::PixelObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetMinimumOutput ( )

◆ GetMinimumOutput() [2/2]

template<class TInputImage >
const PersistentStatisticsImageFilter< TInputImage >::PixelObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetMinimumOutput ( ) const

Return the computed Minimum.

Definition at line 103 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetNameOfClass()

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

Runtime information support.

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

◆ GetSigma()

template<class TInputImage>
RealType otb::PersistentStatisticsImageFilter< TInputImage >::GetSigma ( ) const
inline

Return the computed Standard Deviation.

Definition at line 120 of file otbStreamingStatisticsImageFilter.h.

Referenced by otb::PersistentStatisticsImageFilter< TInputImage >::PrintSelf().

◆ GetSigmaOutput() [1/2]

template<class TInputImage >
PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetSigmaOutput ( )

◆ GetSigmaOutput() [2/2]

template<class TInputImage >
const PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetSigmaOutput ( ) const

Return the computed Standard Deviation.

Definition at line 139 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetSum()

template<class TInputImage>
RealType otb::PersistentStatisticsImageFilter< TInputImage >::GetSum ( ) const
inline

Return the compute Sum.

Definition at line 138 of file otbStreamingStatisticsImageFilter.h.

Referenced by otb::PersistentStatisticsImageFilter< TInputImage >::PrintSelf().

◆ GetSumOutput() [1/2]

template<class TInputImage >
PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetSumOutput ( )

◆ GetSumOutput() [2/2]

template<class TInputImage >
const PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetSumOutput ( ) const

Return the compute Sum.

Definition at line 163 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetUserIgnoredValue()

template<class TInputImage>
virtual RealType otb::PersistentStatisticsImageFilter< TInputImage >::GetUserIgnoredValue ( )
virtual

◆ GetVariance()

template<class TInputImage>
RealType otb::PersistentStatisticsImageFilter< TInputImage >::GetVariance ( ) const
inline

Return the computed Variance.

Definition at line 129 of file otbStreamingStatisticsImageFilter.h.

Referenced by otb::PersistentStatisticsImageFilter< TInputImage >::PrintSelf().

◆ GetVarianceOutput() [1/2]

template<class TInputImage >
PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetVarianceOutput ( )

◆ GetVarianceOutput() [2/2]

template<class TInputImage >
const PersistentStatisticsImageFilter< TInputImage >::RealObjectType * otb::PersistentStatisticsImageFilter< TInputImage >::GetVarianceOutput ( ) const

Return the computed Variance.

Definition at line 151 of file otbStreamingStatisticsImageFilter.hxx.

◆ MakeOutput()

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

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

Definition at line 70 of file otbStreamingStatisticsImageFilter.hxx.

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

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

◆ PrintSelf()

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

◆ Reset()

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

◆ SetIgnoreInfiniteValues()

template<class TInputImage>
virtual void otb::PersistentStatisticsImageFilter< TInputImage >::SetIgnoreInfiniteValues ( bool  _arg)
virtual

◆ SetIgnoreUserDefinedValue()

template<class TInputImage>
virtual void otb::PersistentStatisticsImageFilter< TInputImage >::SetIgnoreUserDefinedValue ( bool  _arg)
virtual

◆ SetUserIgnoredValue()

template<class TInputImage>
virtual void otb::PersistentStatisticsImageFilter< TInputImage >::SetUserIgnoredValue ( RealType  _arg)
virtual

◆ Synthetize()

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

◆ ThreadedGenerateData()

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

Member Data Documentation

◆ ImageDimension

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

Image related typedefs.

Definition at line 79 of file otbStreamingStatisticsImageFilter.h.

◆ InputImageDimension

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

Definition at line 76 of file otbStreamingStatisticsImageFilter.h.

◆ m_Count

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

◆ m_IgnoredInfinitePixelCount

template<class TInputImage>
std::vector<unsigned int> otb::PersistentStatisticsImageFilter< TInputImage >::m_IgnoredInfinitePixelCount
private

◆ m_IgnoredUserPixelCount

template<class TInputImage>
std::vector<unsigned int> otb::PersistentStatisticsImageFilter< TInputImage >::m_IgnoredUserPixelCount
private

◆ m_IgnoreInfiniteValues

template<class TInputImage>
bool otb::PersistentStatisticsImageFilter< TInputImage >::m_IgnoreInfiniteValues
private

◆ m_IgnoreUserDefinedValue

template<class TInputImage>
bool otb::PersistentStatisticsImageFilter< TInputImage >::m_IgnoreUserDefinedValue
private

◆ m_SumOfSquares

template<class TInputImage>
itk::Array<RealType> otb::PersistentStatisticsImageFilter< TInputImage >::m_SumOfSquares
private

◆ m_ThreadMax

template<class TInputImage>
itk::Array<PixelType> otb::PersistentStatisticsImageFilter< TInputImage >::m_ThreadMax
private

◆ m_ThreadMin

template<class TInputImage>
itk::Array<PixelType> otb::PersistentStatisticsImageFilter< TInputImage >::m_ThreadMin
private

◆ m_ThreadSum

template<class TInputImage>
itk::Array<RealType> otb::PersistentStatisticsImageFilter< TInputImage >::m_ThreadSum
private

◆ m_UserIgnoredValue

template<class TInputImage>
RealType otb::PersistentStatisticsImageFilter< TInputImage >::m_UserIgnoredValue
private

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