OTB  10.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::PersistentStatisticsImageFilter< TInputImage > Class Template Reference
Processing images region by region » Filters supporting Streaming | Support for Multithreading » Multithreaded Filters | Group Core » Module OTBStatistics

#include <otbStreamingStatisticsImageFilter.h>

+ Inheritance diagram for otb::PersistentStatisticsImageFilter< TInputImage >:
+ Collaboration diagram for otb::PersistentStatisticsImageFilter< 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 PersistentStatisticsImageFilter 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
 

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_ThreadSum
 
itk::Array< RealType > m_SumOfSquares
 
itk::Array< long > m_Count
 
itk::Array< PixelType > m_ThreadMin
 
itk::Array< PixelType > m_ThreadMax
 
bool m_IgnoreInfiniteValues
 
bool m_IgnoreUserDefinedValue
 
RealType m_UserIgnoredValue
 
std::vector< unsigned int > m_IgnoredInfinitePixelCount
 
std::vector< unsigned int > m_IgnoredUserPixelCount
 
PixelType GetMinimum () const
 
PixelObjectType * GetMinimumOutput ()
 
const PixelObjectType * GetMinimumOutput () const
 
PixelType GetMaximum () const
 
PixelObjectType * GetMaximumOutput ()
 
const PixelObjectType * GetMaximumOutput () const
 
RealType GetMean () const
 
RealObjectType * GetMeanOutput ()
 
const RealObjectType * GetMeanOutput () const
 
RealType GetSigma () const
 
RealObjectType * GetSigmaOutput ()
 
const RealObjectType * GetSigmaOutput () const
 
RealType GetVariance () const
 
RealObjectType * GetVarianceOutput ()
 
const RealObjectType * GetVarianceOutput () const
 
RealType GetSum () const
 
RealObjectType * GetSumOutput ()
 
const RealObjectType * GetSumOutput () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 
void Synthetize (void) override
 
void Reset (void) override
 
virtual void SetIgnoreInfiniteValues (bool _arg)
 
virtual bool GetIgnoreInfiniteValues ()
 
virtual void SetIgnoreUserDefinedValue (bool _arg)
 
virtual bool GetIgnoreUserDefinedValue ()
 
virtual void SetUserIgnoredValue (RealType _arg)
 
virtual RealType GetUserIgnoredValue ()
 
 PersistentStatisticsImageFilter ()
 
 ~PersistentStatisticsImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 PersistentStatisticsImageFilter (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
 
virtual void VerifyInputInformation () const
 
 ~PersistentImageFilter () override
 

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 statistics 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 68 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

Return the computed Minimum.

Definition at line 36 of file otbStreamingStatisticsImageFilter.hxx.

◆ ~PersistentStatisticsImageFilter()

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

Return the computed Minimum.

Definition at line 171 of file otbStreamingStatisticsImageFilter.h.

◆ PersistentStatisticsImageFilter() [2/2]

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

Return the computed Minimum.

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 192 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

Return the computed Minimum.

Definition at line 177 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetIgnoreInfiniteValues()

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

Return the computed Minimum.

◆ GetIgnoreUserDefinedValue()

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

Return the computed Minimum.

◆ GetMaximum()

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

Return the computed Maximum.

Definition at line 102 of file otbStreamingStatisticsImageFilter.h.

◆ GetMaximumOutput() [1/2]

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

Return the computed Minimum.

Definition at line 118 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetMaximumOutput() [2/2]

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

Return the computed Minimum.

Definition at line 124 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.

◆ GetMeanOutput() [1/2]

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

Return the computed Minimum.

Definition at line 130 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetMeanOutput() [2/2]

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

Return the computed Minimum.

Definition at line 136 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.

◆ GetMinimumOutput() [1/2]

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

Return the computed Minimum.

Definition at line 106 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetMinimumOutput() [2/2]

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

Return the computed Minimum.

Definition at line 112 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.

◆ GetSigmaOutput() [1/2]

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

Return the computed Minimum.

Definition at line 142 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetSigmaOutput() [2/2]

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

Return the computed Minimum.

Definition at line 148 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.

◆ GetSumOutput() [1/2]

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

Return the computed Minimum.

Definition at line 166 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetSumOutput() [2/2]

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

Return the computed Minimum.

Definition at line 172 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetUserIgnoredValue()

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

Return the computed Minimum.

◆ GetVariance()

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

Return the computed Variance.

Definition at line 129 of file otbStreamingStatisticsImageFilter.h.

◆ GetVarianceOutput() [1/2]

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

Return the computed Minimum.

Definition at line 154 of file otbStreamingStatisticsImageFilter.hxx.

◆ GetVarianceOutput() [2/2]

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

Return the computed Minimum.

Definition at line 160 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 79 of file otbStreamingStatisticsImageFilter.hxx.

◆ 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

Return the computed Minimum.

◆ PrintSelf()

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

Return the computed Minimum.

Definition at line 346 of file otbStreamingStatisticsImageFilter.hxx.

◆ Reset()

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

Return the computed Minimum.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 266 of file otbStreamingStatisticsImageFilter.hxx.

◆ SetIgnoreInfiniteValues()

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

Return the computed Minimum.

◆ SetIgnoreUserDefinedValue()

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

Return the computed Minimum.

◆ SetUserIgnoredValue()

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

Return the computed Minimum.

◆ Synthetize()

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

Return the computed Minimum.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 202 of file otbStreamingStatisticsImageFilter.hxx.

◆ ThreadedGenerateData()

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

Multi-thread version GenerateData.

Grab the input

Definition at line 294 of file otbStreamingStatisticsImageFilter.hxx.

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

Return the computed Minimum.

Definition at line 185 of file otbStreamingStatisticsImageFilter.h.

◆ m_IgnoredInfinitePixelCount

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

Return the computed Minimum.

Definition at line 193 of file otbStreamingStatisticsImageFilter.h.

◆ m_IgnoredUserPixelCount

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

Return the computed Minimum.

Definition at line 194 of file otbStreamingStatisticsImageFilter.h.

◆ m_IgnoreInfiniteValues

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

Return the computed Minimum.

Definition at line 190 of file otbStreamingStatisticsImageFilter.h.

◆ m_IgnoreUserDefinedValue

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

Return the computed Minimum.

Definition at line 191 of file otbStreamingStatisticsImageFilter.h.

◆ m_SumOfSquares

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

Return the computed Minimum.

Definition at line 184 of file otbStreamingStatisticsImageFilter.h.

◆ m_ThreadMax

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

Return the computed Minimum.

Definition at line 187 of file otbStreamingStatisticsImageFilter.h.

◆ m_ThreadMin

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

Return the computed Minimum.

Definition at line 186 of file otbStreamingStatisticsImageFilter.h.

◆ m_ThreadSum

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

Return the computed Minimum.

Definition at line 183 of file otbStreamingStatisticsImageFilter.h.

◆ m_UserIgnoredValue

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

Return the computed Minimum.

Definition at line 192 of file otbStreamingStatisticsImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Thu Mar 13 2025 14:43:17 for OTB with   doxygen 1.9.1