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

#include <otbStreamingStatisticsImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TInputImage InputImageType
 
typedef itk::SimpleDataObjectDecorator< PixelTypePixelObjectType
 
typedef StatFilterType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SimpleDataObjectDecorator< RealTypeRealObjectType
 
typedef StatFilterType::RealType RealType
 
typedef StreamingStatisticsImageFilter Self
 
typedef Superclass::FilterType StatFilterType
 
typedef PersistentFilterStreamingDecorator< PersistentStatisticsImageFilter< TInputImage > > Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentStatisticsImageFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentStatisticsImageFilter< 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
 
const InputImageTypeGetInput ()
 
PixelType GetMaximum () const
 
PixelObjectTypeGetMaximumOutput ()
 
const PixelObjectTypeGetMaximumOutput () const
 
PixelType GetMinimum () const
 
PixelObjectTypeGetMinimumOutput ()
 
const PixelObjectTypeGetMinimumOutput () const
 
virtual const char * GetNameOfClass () const
 
 otbGetObjectMemberMacro (Filter, IgnoreInfiniteValues, bool)
 
 otbGetObjectMemberMacro (Filter, IgnoreUserDefinedValue, bool)
 
 otbGetObjectMemberMacro (Filter, UserIgnoredValue, RealType)
 
 otbSetObjectMemberMacro (Filter, IgnoreInfiniteValues, bool)
 
 otbSetObjectMemberMacro (Filter, IgnoreUserDefinedValue, bool)
 
 otbSetObjectMemberMacro (Filter, UserIgnoredValue, RealType)
 
void SetInput (InputImageType *input)
 
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
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentStatisticsImageFilter< 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< PersistentStatisticsImageFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

 StreamingStatisticsImageFilter ()
 
 ~StreamingStatisticsImageFilter () override
 
- Protected Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentStatisticsImageFilter< 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
 
 StreamingStatisticsImageFilter (const Self &)=delete
 

Additional Inherited Members

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

Detailed Description

template<class TInputImage>
class otb::StreamingStatisticsImageFilter< TInputImage >

This class streams the whole input image through the PersistentStatisticsImageFilter.

This way, it allows computing the first order global statistics of this image. It calls the Reset() method of the PersistentStatisticsImageFilter before streaming the image and the Synthetize() method of the PersistentStatisticsImageFilter after having streamed the image to compute the statistics. The accessor on the results are wrapping the accessors of the internal PersistentStatisticsImageFilter. By default infinite values are ignored, use IgnoreInfiniteValues accessor to consider infinite values in the computation.

This filter can be used as:

StatisticsType::Pointer statistics = StatisticsType::New();
statistics->SetInput(reader->GetOutput());
statistics->Update();
std::cout << statistics-> GetMaximum() << std::endl;
std::cout << statistics-> GetMinimum() << std::endl;
See also
PersistentStatisticsImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 234 of file otbStreamingStatisticsImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 241 of file otbStreamingStatisticsImageFilter.h.

◆ InputImageType

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

Definition at line 252 of file otbStreamingStatisticsImageFilter.h.

◆ PixelObjectType

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

Definition at line 256 of file otbStreamingStatisticsImageFilter.h.

◆ PixelType

template<class TInputImage >
typedef StatFilterType::PixelType otb::StreamingStatisticsImageFilter< TInputImage >::PixelType

Definition at line 250 of file otbStreamingStatisticsImageFilter.h.

◆ Pointer

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

Definition at line 240 of file otbStreamingStatisticsImageFilter.h.

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 255 of file otbStreamingStatisticsImageFilter.h.

◆ RealType

template<class TInputImage >
typedef StatFilterType::RealType otb::StreamingStatisticsImageFilter< TInputImage >::RealType

Definition at line 251 of file otbStreamingStatisticsImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 238 of file otbStreamingStatisticsImageFilter.h.

◆ StatFilterType

template<class TInputImage >
typedef Superclass::FilterType otb::StreamingStatisticsImageFilter< TInputImage >::StatFilterType

Definition at line 247 of file otbStreamingStatisticsImageFilter.h.

◆ Superclass

Definition at line 239 of file otbStreamingStatisticsImageFilter.h.

Constructor & Destructor Documentation

◆ StreamingStatisticsImageFilter() [1/2]

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

Constructor

Definition at line 367 of file otbStreamingStatisticsImageFilter.h.

◆ ~StreamingStatisticsImageFilter()

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

Destructor

Definition at line 370 of file otbStreamingStatisticsImageFilter.h.

◆ StreamingStatisticsImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetInput()

template<class TInputImage >
const InputImageType* otb::StreamingStatisticsImageFilter< TInputImage >::GetInput ( void  )
inline

Definition at line 263 of file otbStreamingStatisticsImageFilter.h.

◆ GetMaximum()

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

Return the computed Maximum.

Definition at line 283 of file otbStreamingStatisticsImageFilter.h.

◆ GetMaximumOutput() [1/2]

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

Definition at line 287 of file otbStreamingStatisticsImageFilter.h.

◆ GetMaximumOutput() [2/2]

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

Definition at line 291 of file otbStreamingStatisticsImageFilter.h.

◆ GetMean()

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

Return the computed Mean.

Definition at line 297 of file otbStreamingStatisticsImageFilter.h.

◆ GetMeanOutput() [1/2]

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

Return the computed Mean.

Definition at line 301 of file otbStreamingStatisticsImageFilter.h.

◆ GetMeanOutput() [2/2]

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

Return the computed Mean.

Definition at line 305 of file otbStreamingStatisticsImageFilter.h.

◆ GetMinimum()

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

Return the computed Minimum.

Definition at line 269 of file otbStreamingStatisticsImageFilter.h.

◆ GetMinimumOutput() [1/2]

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

Definition at line 273 of file otbStreamingStatisticsImageFilter.h.

◆ GetMinimumOutput() [2/2]

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

Definition at line 277 of file otbStreamingStatisticsImageFilter.h.

◆ GetNameOfClass()

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

Creation through object factory macro

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

◆ GetSigma()

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

Return the computed Standard Deviation.

Definition at line 312 of file otbStreamingStatisticsImageFilter.h.

◆ GetSigmaOutput() [1/2]

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

Return the computed Standard Deviation.

Definition at line 316 of file otbStreamingStatisticsImageFilter.h.

◆ GetSigmaOutput() [2/2]

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

Return the computed Standard Deviation.

Definition at line 320 of file otbStreamingStatisticsImageFilter.h.

◆ GetSum()

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

Return the compute Sum.

Definition at line 342 of file otbStreamingStatisticsImageFilter.h.

◆ GetSumOutput() [1/2]

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

Return the compute Sum.

Definition at line 346 of file otbStreamingStatisticsImageFilter.h.

◆ GetSumOutput() [2/2]

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

Return the compute Sum.

Definition at line 350 of file otbStreamingStatisticsImageFilter.h.

References otb::Wrapper::Tags::Filter, otbGetObjectMemberMacro, and otbSetObjectMemberMacro.

◆ GetVariance()

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

Return the computed Variance.

Definition at line 327 of file otbStreamingStatisticsImageFilter.h.

◆ GetVarianceOutput() [1/2]

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

Return the computed Variance.

Definition at line 331 of file otbStreamingStatisticsImageFilter.h.

◆ GetVarianceOutput() [2/2]

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

Return the computed Variance.

Definition at line 335 of file otbStreamingStatisticsImageFilter.h.

◆ New()

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

Type macro

◆ operator=()

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

◆ otbGetObjectMemberMacro() [1/3]

template<class TInputImage >
otb::StreamingStatisticsImageFilter< TInputImage >::otbGetObjectMemberMacro ( Filter  ,
IgnoreInfiniteValues  ,
bool   
)

◆ otbGetObjectMemberMacro() [2/3]

template<class TInputImage >
otb::StreamingStatisticsImageFilter< TInputImage >::otbGetObjectMemberMacro ( Filter  ,
IgnoreUserDefinedValue  ,
bool   
)

◆ otbGetObjectMemberMacro() [3/3]

template<class TInputImage >
otb::StreamingStatisticsImageFilter< TInputImage >::otbGetObjectMemberMacro ( Filter  ,
UserIgnoredValue  ,
RealType   
)

◆ otbSetObjectMemberMacro() [1/3]

template<class TInputImage >
otb::StreamingStatisticsImageFilter< TInputImage >::otbSetObjectMemberMacro ( Filter  ,
IgnoreInfiniteValues  ,
bool   
)

◆ otbSetObjectMemberMacro() [2/3]

template<class TInputImage >
otb::StreamingStatisticsImageFilter< TInputImage >::otbSetObjectMemberMacro ( Filter  ,
IgnoreUserDefinedValue  ,
bool   
)

◆ otbSetObjectMemberMacro() [3/3]

template<class TInputImage >
otb::StreamingStatisticsImageFilter< TInputImage >::otbSetObjectMemberMacro ( Filter  ,
UserIgnoredValue  ,
RealType   
)

◆ SetInput()

template<class TInputImage >
void otb::StreamingStatisticsImageFilter< TInputImage >::SetInput ( InputImageType input)
inline

Definition at line 259 of file otbStreamingStatisticsImageFilter.h.


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