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

Compute min. max, variance and mean of an image using the output requested region. More...

#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 TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef
itk::SimpleDataObjectDecorator
< PixelType
PixelObjectType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
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< SelfPointer
 
typedef PersistentImageFilter Self
 
typedef
itk::ImageToImageFilter
< TInputImage, TInputImage > 
Superclass
 

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

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

Protected Member Functions

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

Private Member Functions

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

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 49 of file otbStreamingStatisticsImageFilter.h.

Member Typedef Documentation

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

Definition at line 57 of file otbStreamingStatisticsImageFilter.h.

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.

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

Image related typedefs.

Definition at line 63 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 71 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 67 of file otbStreamingStatisticsImageFilter.h.

Definition at line 89 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 72 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 56 of file otbStreamingStatisticsImageFilter.h.

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

Type of DataObjects used for scalar outputs

Definition at line 88 of file otbStreamingStatisticsImageFilter.h.

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.

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

Definition at line 69 of file otbStreamingStatisticsImageFilter.h.

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

Standard Self typedef

Definition at line 54 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 70 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 55 of file otbStreamingStatisticsImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage >
otb::PersistentStatisticsImageFilter< TInputImage >::PersistentStatisticsImageFilter ( )
protected
template<class TInputImage >
virtual otb::PersistentStatisticsImageFilter< TInputImage >::~PersistentStatisticsImageFilter ( )
inlineprotectedvirtual

Definition at line 162 of file otbStreamingStatisticsImageFilter.h.

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

Member Function Documentation

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

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

Definition at line 223 of file otbStreamingStatisticsImageFilter.txx.

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

Definition at line 206 of file otbStreamingStatisticsImageFilter.txx.

template<class TInputImage >
virtual bool otb::PersistentStatisticsImageFilter< TInputImage >::GetIgnoreInfiniteValues ( )
virtual
template<class TInputImage >
virtual bool otb::PersistentStatisticsImageFilter< TInputImage >::GetIgnoreUserDefinedValue ( )
virtual
template<class TInputImage >
PixelType otb::PersistentStatisticsImageFilter< TInputImage >::GetMaximum ( ) const
inline

Return the computed Maximum.

Definition at line 100 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 127 of file otbStreamingStatisticsImageFilter.txx.

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

Definition at line 135 of file otbStreamingStatisticsImageFilter.txx.

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

Return the computed Mean.

Definition at line 108 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 143 of file otbStreamingStatisticsImageFilter.txx.

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

Definition at line 151 of file otbStreamingStatisticsImageFilter.txx.

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

Return the computed Minimum.

Definition at line 92 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 111 of file otbStreamingStatisticsImageFilter.txx.

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

Definition at line 119 of file otbStreamingStatisticsImageFilter.txx.

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

Runtime information support.

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

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

Return the computed Standard Deviation.

Definition at line 116 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 159 of file otbStreamingStatisticsImageFilter.txx.

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

Definition at line 167 of file otbStreamingStatisticsImageFilter.txx.

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

Return the compute Sum.

Definition at line 132 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 191 of file otbStreamingStatisticsImageFilter.txx.

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

Definition at line 199 of file otbStreamingStatisticsImageFilter.txx.

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

Return the computed Variance.

Definition at line 124 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 175 of file otbStreamingStatisticsImageFilter.txx.

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

Definition at line 183 of file otbStreamingStatisticsImageFilter.txx.

template<class TInputImage >
itk::DataObject::Pointer otb::PersistentStatisticsImageFilter< TInputImage >::MakeOutput ( unsigned int  idx)
virtual

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

Definition at line 82 of file otbStreamingStatisticsImageFilter.txx.

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

Method for creation through the object factory.

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

PrintSelf method

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

Definition at line 376 of file otbStreamingStatisticsImageFilter.txx.

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

Reset the persistent data of the filter.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 292 of file otbStreamingStatisticsImageFilter.txx.

template<class TInputImage >
virtual void otb::PersistentStatisticsImageFilter< TInputImage >::SetIgnoreInfiniteValues ( bool  _arg)
virtual
template<class TInputImage >
virtual void otb::PersistentStatisticsImageFilter< TInputImage >::SetIgnoreUserDefinedValue ( bool  _arg)
virtual
template<class TInputImage >
virtual void otb::PersistentStatisticsImageFilter< TInputImage >::SetUserIgnoredValue ( RealType  _arg)
virtual
template<class TInputImage >
void otb::PersistentStatisticsImageFilter< TInputImage >::Synthetize ( void  )
virtual
template<class TInputImage >
void otb::PersistentStatisticsImageFilter< TInputImage >::ThreadedGenerateData ( const RegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protected

Member Data Documentation

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

Image related typedefs.

Definition at line 79 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 75 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 176 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 184 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 185 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 181 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 182 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 175 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 178 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 177 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 174 of file otbStreamingStatisticsImageFilter.h.

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

Definition at line 183 of file otbStreamingStatisticsImageFilter.h.


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