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

#include <otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h>

+ Inheritance diagram for otb::SARStreamingMeanPhaseAndAzimutShiftImageFilter< TInputImage >:
+ Collaboration diagram for otb::SARStreamingMeanPhaseAndAzimutShiftImageFilter< 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 SARStreamingMeanPhaseAndAzimutShiftImageFilter Self
 
typedef Superclass::FilterType StatFilterType
 
typedef PersistentFilterStreamingDecorator< PersistentMeanPhaseAndAzimutShiftImageFilter< TInputImage > > Superclass
 
typedef itk::SimpleDataObjectDecorator< ValueTypeValueObjectType
 
typedef double ValueType
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentMeanPhaseAndAzimutShiftImageFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentMeanPhaseAndAzimutShiftImageFilter< 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 ()
 
ValueType GetMean ()
 
virtual const char * GetNameOfClass () const
 
bool getOverlapLinesAndSamples (ImageKeywordlist SLCImageKWL, std::pair< unsigned long, unsigned long > &linesUp, std::pair< unsigned long, unsigned long > &linesLow, std::pair< unsigned long, unsigned long > &samplesUp, std::pair< unsigned long, unsigned long > &samplesLow, unsigned int burstIndUp, bool inputWithInvalidPixels)
 
 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)
 
void SetPhaseMean (bool phaseMean)
 
void SetThreshold (double threshold)
 
long GetCount () const
 
LongObjectTypeGetCountOutput ()
 
const LongObjectTypeGetCountOutput () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMeanPhaseAndAzimutShiftImageFilter< 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< PersistentMeanPhaseAndAzimutShiftImageFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

template<class TInputImage>
class otb::SARStreamingMeanPhaseAndAzimutShiftImageFilter< TInputImage >

This class streams the whole input image through the PersistentMeanPhaseAndAzimutShiftImageFilter.

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

This filter can be used as:

typedef otb::StreamingMeanPhaseAndAzimutShiftImageFilter<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
PersistentMeanPhaseAndAzimutShiftImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 234 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

◆ InputImageType

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

◆ LongObjectType

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

◆ PixelObjectType

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

◆ PixelType

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

◆ Pointer

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

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 258 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

◆ RealType

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

◆ Self

Standard Self typedef

Definition at line 239 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

◆ StatFilterType

◆ Superclass

◆ ValueObjectType

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

◆ ValueType

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

Constructor & Destructor Documentation

◆ SARStreamingMeanPhaseAndAzimutShiftImageFilter() [1/2]

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

Constructor

Definition at line 352 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

◆ ~SARStreamingMeanPhaseAndAzimutShiftImageFilter()

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

Destructor

Definition at line 355 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

◆ SARStreamingMeanPhaseAndAzimutShiftImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetCount()

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

Return the computed number of finite pixel.

Definition at line 279 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

◆ GetCountOutput() [1/2]

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

Return the computed number of finite pixel.

Definition at line 283 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

◆ GetCountOutput() [2/2]

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

Return the computed number of finite pixel.

Definition at line 287 of file otbSARStreamingMeanPhaseAndAzimutShiftImageFilter.h.

◆ GetInput()

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

◆ GetMean()

template<class TInputImage >
ValueType otb::SARStreamingMeanPhaseAndAzimutShiftImageFilter< TInputImage >::GetMean ( )
inline

◆ GetNameOfClass()

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

◆ getOverlapLinesAndSamples()

template<class TInputImage >
bool otb::SARStreamingMeanPhaseAndAzimutShiftImageFilter< TInputImage >::getOverlapLinesAndSamples ( ImageKeywordlist  SLCImageKWL,
std::pair< unsigned long, unsigned long > &  linesUp,
std::pair< unsigned long, unsigned long > &  linesLow,
std::pair< unsigned long, unsigned long > &  samplesUp,
std::pair< unsigned long, unsigned long > &  samplesLow,
unsigned int  burstIndUp,
bool  inputWithInvalidPixels 
)
inline

◆ New()

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

Type macro

◆ operator=()

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

◆ otbGetObjectMemberMacro() [1/3]

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

◆ otbGetObjectMemberMacro() [2/3]

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

◆ otbGetObjectMemberMacro() [3/3]

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

◆ otbSetObjectMemberMacro() [1/3]

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

◆ otbSetObjectMemberMacro() [2/3]

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

◆ otbSetObjectMemberMacro() [3/3]

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

◆ SetInput()

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

◆ SetPhaseMean()

template<class TInputImage >
void otb::SARStreamingMeanPhaseAndAzimutShiftImageFilter< TInputImage >::SetPhaseMean ( bool  phaseMean)
inline

◆ SetThreshold()

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

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