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

#include <otbSARStreamingMaximumMinimumImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SimpleDataObjectDecorator< IndexTypeIndexObjectType
 
typedef TInputImage::IndexType IndexType
 
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 SARStreamingMaximumMinimumImageFilter Self
 
typedef Superclass::FilterType StatFilterType
 
typedef PersistentFilterStreamingDecorator< PersistentMaximumMinimumImageFilter< TInputImage > > Superclass
 
typedef itk::SimpleDataObjectDecorator< ValueTypeValueObjectType
 
typedef double ValueType
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentMaximumMinimumImageFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentMaximumMinimumImageFilter< 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
 
IndexType GetIndexOfMax ()
 
IndexType GetIndexOfMin ()
 
const InputImageTypeGetInput ()
 
ValueType GetMax ()
 
ValueType GetMin ()
 
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)
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMaximumMinimumImageFilter< 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< PersistentMaximumMinimumImageFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

template<class TInputImage>
class otb::SARStreamingMaximumMinimumImageFilter< TInputImage >

This class streams the whole input image through the PersistentMaximumMinimumImageFilter.

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

This filter can be used as:

typedef otb::StreamingMaximumMinimumImageFilter<ImageType> StatisticsType;
StatisticsType::Pointer statistics = StatisticsType::New();
statistics->SetInput(reader->GetOutput());
statistics->Update();
std::cout << statistics-> GetIndexOfMax() << std::endl;
std::cout << statistics-> GetMax() << std::endl;
See also
PersistentMaximumMinimumImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 243 of file otbSARStreamingMaximumMinimumImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 252 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ IndexObjectType

template<class TInputImage >
typedef itk::SimpleDataObjectDecorator<IndexType> otb::SARStreamingMaximumMinimumImageFilter< TInputImage >::IndexObjectType

Definition at line 272 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ IndexType

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

Definition at line 265 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ InputImageType

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

Definition at line 264 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ LongObjectType

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

Definition at line 269 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ PixelObjectType

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

Definition at line 270 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ PixelType

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

Definition at line 261 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ Pointer

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

Definition at line 251 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 268 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ RealType

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

Definition at line 263 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 248 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ StatFilterType

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

Definition at line 258 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ Superclass

Definition at line 250 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ ValueObjectType

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

Definition at line 271 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ ValueType

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

Definition at line 262 of file otbSARStreamingMaximumMinimumImageFilter.h.

Constructor & Destructor Documentation

◆ SARStreamingMaximumMinimumImageFilter() [1/2]

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

Constructor

Definition at line 317 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ ~SARStreamingMaximumMinimumImageFilter()

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

Destructor

Definition at line 320 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ SARStreamingMaximumMinimumImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetIndexOfMax()

template<class TInputImage >
IndexType otb::SARStreamingMaximumMinimumImageFilter< TInputImage >::GetIndexOfMax ( )
inline

Definition at line 284 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ GetIndexOfMin()

template<class TInputImage >
IndexType otb::SARStreamingMaximumMinimumImageFilter< TInputImage >::GetIndexOfMin ( )
inline

Definition at line 289 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ GetInput()

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

Definition at line 279 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ GetMax()

template<class TInputImage >
ValueType otb::SARStreamingMaximumMinimumImageFilter< TInputImage >::GetMax ( )
inline

Definition at line 295 of file otbSARStreamingMaximumMinimumImageFilter.h.

◆ GetMin()

template<class TInputImage >
ValueType otb::SARStreamingMaximumMinimumImageFilter< TInputImage >::GetMin ( )
inline

◆ GetNameOfClass()

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

◆ New()

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

Type macro

◆ operator=()

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

◆ otbGetObjectMemberMacro() [1/3]

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

◆ otbGetObjectMemberMacro() [2/3]

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

◆ otbGetObjectMemberMacro() [3/3]

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

◆ otbSetObjectMemberMacro() [1/3]

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

◆ otbSetObjectMemberMacro() [2/3]

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

◆ otbSetObjectMemberMacro() [3/3]

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

◆ SetInput()

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

Definition at line 275 of file otbSARStreamingMaximumMinimumImageFilter.h.


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