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
otb::SARStreamingGridInformationImageFilter< TInputImage > Class Template Reference

#include <otbSARStreamingGridInformationImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TInputImage InputImageType
 
typedef itk::SimpleDataObjectDecorator< long > LongObjectType
 
typedef itk::SimpleDataObjectDecorator< PixelTypePixelObjectType
 
typedef StatFilterType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SimpleDataObjectDecorator< RealTypeRealObjectType
 
typedef StatFilterType::RealType RealType
 
typedef SARStreamingGridInformationImageFilter Self
 
typedef Superclass::FilterType StatFilterType
 
typedef PersistentFilterStreamingDecorator< PersistentGridInformationImageFilter< TInputImage > > Superclass
 
typedef itk::SimpleDataObjectDecorator< ValueTypeValueObjectType
 
typedef double ValueType
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentGridInformationImageFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentGridInformationImageFilter< 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 ()
 
void GetMean (ValueType &meanRange, ValueType &meanAzimut)
 
void GetMinMax (ValueType &minRange, ValueType &minAzimut, ValueType &maxRange, ValueType &maxAzimut)
 
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 SetEstimateMean (bool estimateMean)
 
void SetInput (InputImageType *input)
 
void SetThreshold (double threshold)
 
long GetCount () const
 
LongObjectTypeGetCountOutput ()
 
const LongObjectTypeGetCountOutput () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentGridInformationImageFilter< 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< PersistentGridInformationImageFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

 SARStreamingGridInformationImageFilter ()
 
 ~SARStreamingGridInformationImageFilter () ITK_OVERRIDE
 
- Protected Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentGridInformationImageFilter< 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 &)
 
 SARStreamingGridInformationImageFilter (const Self &)
 

Additional Inherited Members

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

Detailed Description

template<class TInputImage>
class otb::SARStreamingGridInformationImageFilter< TInputImage >

This class streams the whole input image through the PersistentGridInformationImageFilter.

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

This filter can be used as:

typedef otb::StreamingGridInformationImageFilter<ImageType> StatisticsType;
StatisticsType::Pointer statistics = StatisticsType::New();
statistics->SetInput(reader->GetOutput());
statistics->Update();
std::cout << statistics-> GetSumRange() << std::endl;
std::cout << statistics-> GetSumAzimut() << std::endl;
std::cout << statistics-> GetMeanGrid(meanRange, meanAzimut) << std::endl;
See also
PersistentGridInformationImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 285 of file otbSARStreamingGridInformationImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 294 of file otbSARStreamingGridInformationImageFilter.h.

◆ InputImageType

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

Definition at line 306 of file otbSARStreamingGridInformationImageFilter.h.

◆ LongObjectType

template<class TInputImage >
typedef itk::SimpleDataObjectDecorator<long> otb::SARStreamingGridInformationImageFilter< TInputImage >::LongObjectType

Definition at line 310 of file otbSARStreamingGridInformationImageFilter.h.

◆ PixelObjectType

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

Definition at line 311 of file otbSARStreamingGridInformationImageFilter.h.

◆ PixelType

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

Definition at line 303 of file otbSARStreamingGridInformationImageFilter.h.

◆ Pointer

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

Definition at line 293 of file otbSARStreamingGridInformationImageFilter.h.

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 309 of file otbSARStreamingGridInformationImageFilter.h.

◆ RealType

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

Definition at line 305 of file otbSARStreamingGridInformationImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 290 of file otbSARStreamingGridInformationImageFilter.h.

◆ StatFilterType

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

Definition at line 300 of file otbSARStreamingGridInformationImageFilter.h.

◆ Superclass

Definition at line 292 of file otbSARStreamingGridInformationImageFilter.h.

◆ ValueObjectType

template<class TInputImage >
typedef itk::SimpleDataObjectDecorator<ValueType> otb::SARStreamingGridInformationImageFilter< TInputImage >::ValueObjectType

Definition at line 312 of file otbSARStreamingGridInformationImageFilter.h.

◆ ValueType

template<class TInputImage >
typedef double otb::SARStreamingGridInformationImageFilter< TInputImage >::ValueType

Definition at line 304 of file otbSARStreamingGridInformationImageFilter.h.

Constructor & Destructor Documentation

◆ SARStreamingGridInformationImageFilter() [1/2]

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

Constructor

Definition at line 386 of file otbSARStreamingGridInformationImageFilter.h.

◆ ~SARStreamingGridInformationImageFilter()

template<class TInputImage >
otb::SARStreamingGridInformationImageFilter< TInputImage >::~SARStreamingGridInformationImageFilter ( )
inlineprotected

Destructor

Definition at line 389 of file otbSARStreamingGridInformationImageFilter.h.

◆ SARStreamingGridInformationImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetCount()

template<class TInputImage >
long otb::SARStreamingGridInformationImageFilter< TInputImage >::GetCount ( ) const
inline

Return the computed number of finite pixel.

Definition at line 330 of file otbSARStreamingGridInformationImageFilter.h.

◆ GetCountOutput() [1/2]

template<class TInputImage >
LongObjectType* otb::SARStreamingGridInformationImageFilter< TInputImage >::GetCountOutput ( )
inline

Return the computed number of finite pixel.

Definition at line 334 of file otbSARStreamingGridInformationImageFilter.h.

◆ GetCountOutput() [2/2]

template<class TInputImage >
const LongObjectType* otb::SARStreamingGridInformationImageFilter< TInputImage >::GetCountOutput ( ) const
inline

Return the computed number of finite pixel.

Definition at line 338 of file otbSARStreamingGridInformationImageFilter.h.

◆ GetInput()

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

Definition at line 319 of file otbSARStreamingGridInformationImageFilter.h.

◆ GetMean()

template<class TInputImage >
void otb::SARStreamingGridInformationImageFilter< TInputImage >::GetMean ( ValueType meanRange,
ValueType meanAzimut 
)
inline

Definition at line 345 of file otbSARStreamingGridInformationImageFilter.h.

◆ GetMinMax()

template<class TInputImage >
void otb::SARStreamingGridInformationImageFilter< TInputImage >::GetMinMax ( ValueType minRange,
ValueType minAzimut,
ValueType maxRange,
ValueType maxAzimut 
)
inline

Definition at line 360 of file otbSARStreamingGridInformationImageFilter.h.

◆ GetNameOfClass()

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

◆ New()

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

Type macro

◆ operator=()

template<class TInputImage >
void otb::SARStreamingGridInformationImageFilter< TInputImage >::operator= ( const Self )
private

◆ otbGetObjectMemberMacro() [1/3]

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

◆ otbGetObjectMemberMacro() [2/3]

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

◆ otbGetObjectMemberMacro() [3/3]

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

◆ otbSetObjectMemberMacro() [1/3]

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

◆ otbSetObjectMemberMacro() [2/3]

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

◆ otbSetObjectMemberMacro() [3/3]

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

◆ SetEstimateMean()

template<class TInputImage >
void otb::SARStreamingGridInformationImageFilter< TInputImage >::SetEstimateMean ( bool  estimateMean)
inline

Definition at line 324 of file otbSARStreamingGridInformationImageFilter.h.

◆ SetInput()

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

Definition at line 315 of file otbSARStreamingGridInformationImageFilter.h.

◆ SetThreshold()

template<class TInputImage >
void otb::SARStreamingGridInformationImageFilter< TInputImage >::SetThreshold ( double  threshold)
inline

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