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

#include <otbSARStreamingCorrelationImageFilter.h>

+ Inheritance diagram for otb::SARStreamingCorrelationImageFilter< TInputImage >:
+ Collaboration diagram for otb::SARStreamingCorrelationImageFilter< 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 SARStreamingCorrelationImageFilter Self
 
typedef Superclass::FilterType StatFilterType
 
typedef PersistentFilterStreamingDecorator< PersistentCorrelationImageFilter< TInputImage > > Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentCorrelationImageFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentCorrelationImageFilter< 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
 
PixelType GetCorrelation () const
 
PixelObjectTypeGetCorrelationOutput ()
 
const PixelObjectTypeGetCorrelationOutput () const
 
long GetCount () const
 
LongObjectTypeGetCountOutput ()
 
const LongObjectTypeGetCountOutput () const
 
double GetDoppler ()
 
const InputImageTypeGetInput ()
 
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)
 
PixelType GetSum () const
 
PixelObjectTypeGetSumOutput ()
 
const PixelObjectTypeGetSumOutput () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentCorrelationImageFilter< 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< PersistentCorrelationImageFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

template<class TInputImage>
class otb::SARStreamingCorrelationImageFilter< TInputImage >

This class streams the whole input image through the PersistentCorrelationImageFilter.

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

This filter can be used as:

typedef otb::StreamingCorrelationImageFilter<ImageType> StatisticsType;
StatisticsType::Pointer statistics = StatisticsType::New();
statistics->SetInput(reader->GetOutput());
statistics->Update();
std::cout << statistics-> GetSum() << std::endl;
std::cout << statistics-> GetCorrelation() << std::endl;
See also
PersistentCorrelationImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 228 of file otbSARStreamingCorrelationImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 237 of file otbSARStreamingCorrelationImageFilter.h.

◆ InputImageType

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

Definition at line 248 of file otbSARStreamingCorrelationImageFilter.h.

◆ LongObjectType

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

Definition at line 252 of file otbSARStreamingCorrelationImageFilter.h.

◆ PixelObjectType

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

Definition at line 253 of file otbSARStreamingCorrelationImageFilter.h.

◆ PixelType

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

Definition at line 246 of file otbSARStreamingCorrelationImageFilter.h.

◆ Pointer

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

Definition at line 236 of file otbSARStreamingCorrelationImageFilter.h.

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 251 of file otbSARStreamingCorrelationImageFilter.h.

◆ RealType

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

Definition at line 247 of file otbSARStreamingCorrelationImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 233 of file otbSARStreamingCorrelationImageFilter.h.

◆ StatFilterType

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

Definition at line 243 of file otbSARStreamingCorrelationImageFilter.h.

◆ Superclass

Definition at line 235 of file otbSARStreamingCorrelationImageFilter.h.

Constructor & Destructor Documentation

◆ SARStreamingCorrelationImageFilter() [1/2]

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

Constructor

Definition at line 341 of file otbSARStreamingCorrelationImageFilter.h.

◆ ~SARStreamingCorrelationImageFilter()

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

Destructor

Definition at line 344 of file otbSARStreamingCorrelationImageFilter.h.

◆ SARStreamingCorrelationImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetCorrelation()

template<class TInputImage >
PixelType otb::SARStreamingCorrelationImageFilter< TInputImage >::GetCorrelation ( ) const
inline

Return the computed Minimum.

Definition at line 266 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetCorrelationOutput() [1/2]

template<class TInputImage >
PixelObjectType* otb::SARStreamingCorrelationImageFilter< TInputImage >::GetCorrelationOutput ( )
inline

Definition at line 270 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetCorrelationOutput() [2/2]

template<class TInputImage >
const PixelObjectType* otb::SARStreamingCorrelationImageFilter< TInputImage >::GetCorrelationOutput ( ) const
inline

Definition at line 274 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetCount()

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

Return the computed number of finite pixel.

Definition at line 280 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetCountOutput() [1/2]

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

Definition at line 284 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetCountOutput() [2/2]

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

Definition at line 288 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetDoppler()

template<class TInputImage >
double otb::SARStreamingCorrelationImageFilter< TInputImage >::GetDoppler ( )
inline

◆ GetInput()

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

Definition at line 260 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetNameOfClass()

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

Creation through object factory macro

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

◆ GetSum()

template<class TInputImage >
PixelType otb::SARStreamingCorrelationImageFilter< TInputImage >::GetSum ( ) const
inline

Return the computed Sum.

Definition at line 294 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetSumOutput() [1/2]

template<class TInputImage >
PixelObjectType* otb::SARStreamingCorrelationImageFilter< TInputImage >::GetSumOutput ( )
inline

Return the computed Sum.

Definition at line 298 of file otbSARStreamingCorrelationImageFilter.h.

◆ GetSumOutput() [2/2]

template<class TInputImage >
const PixelObjectType* otb::SARStreamingCorrelationImageFilter< TInputImage >::GetSumOutput ( ) const
inline

Return the computed Sum.

Definition at line 302 of file otbSARStreamingCorrelationImageFilter.h.

◆ New()

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

Type macro

◆ operator=()

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

◆ otbGetObjectMemberMacro() [1/3]

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

◆ otbGetObjectMemberMacro() [2/3]

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

◆ otbGetObjectMemberMacro() [3/3]

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

◆ otbSetObjectMemberMacro() [1/3]

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

◆ otbSetObjectMemberMacro() [2/3]

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

◆ otbSetObjectMemberMacro() [3/3]

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

◆ SetInput()

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

Definition at line 256 of file otbSARStreamingCorrelationImageFilter.h.


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