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 <otbStreamingMinMaxImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef StatFilterType::IndexObjectType IndexObjectType
 
typedef StatFilterType::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef StatFilterType::PixelObjectType PixelObjectType
 
typedef StatFilterType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StreamingMinMaxImageFilter Self
 
typedef Superclass::FilterType StatFilterType
 
typedef PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< TInputImage > > Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentMinMaxImageFilter< 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 GetMinimum () const
 
IndexType GetMinimumIndex () const
 
IndexObjectTypeGetMinimumIndexOutput ()
 
const IndexObjectTypeGetMinimumIndexOutput () const
 
PixelObjectTypeGetMinimumOutput ()
 
const PixelObjectTypeGetMinimumOutput () const
 
virtual const char * GetNameOfClass () const
 
void SetInput (InputImageType *input)
 
PixelType GetMaximum () const
 
PixelObjectTypeGetMaximumOutput ()
 
const PixelObjectTypeGetMaximumOutput () const
 
IndexType GetMaximumIndex () const
 
IndexObjectTypeGetMaximumIndexOutput ()
 
const IndexObjectTypeGetMaximumIndexOutput () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< 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< PersistentMinMaxImageFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

template<class TInputImage>
class otb::StreamingMinMaxImageFilter< TInputImage >

This class streams the whole input image through the PersistentMinMaxImageFilter.

This way, it allows computing the minimum and maximum of this image.

It calls the Reset() method of the PersistentMinMaxImageFilter before streaming the image and the Synthetize() method of the PersistentMinMaxImageFilter after having streamed the image to compute the statistics.

This filter can be used as:

MinMaxType::Pointer minmax = MinMaxType::New();
minmax->SetInput(reader->GetOutput());
minmax->Update();
std::cout << minmax-> GetMaximum() << std::endl;
std::cout << minmax-> GetMinimum() << std::endl;
std::cout << minmax-> GetMaximumIndex() << std::endl;
std::cout << minmax-> GetMinimumIndex() << std::endl;
See also
PersistentMinMaxImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 194 of file otbStreamingMinMaxImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 201 of file otbStreamingMinMaxImageFilter.h.

◆ IndexObjectType

template<class TInputImage >
typedef StatFilterType::IndexObjectType otb::StreamingMinMaxImageFilter< TInputImage >::IndexObjectType

Definition at line 213 of file otbStreamingMinMaxImageFilter.h.

◆ IndexType

template<class TInputImage >
typedef StatFilterType::IndexType otb::StreamingMinMaxImageFilter< TInputImage >::IndexType

Definition at line 211 of file otbStreamingMinMaxImageFilter.h.

◆ InputImageType

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

Definition at line 214 of file otbStreamingMinMaxImageFilter.h.

◆ PixelObjectType

template<class TInputImage >
typedef StatFilterType::PixelObjectType otb::StreamingMinMaxImageFilter< TInputImage >::PixelObjectType

Definition at line 212 of file otbStreamingMinMaxImageFilter.h.

◆ PixelType

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

Definition at line 210 of file otbStreamingMinMaxImageFilter.h.

◆ Pointer

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

Definition at line 200 of file otbStreamingMinMaxImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 198 of file otbStreamingMinMaxImageFilter.h.

◆ StatFilterType

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

Definition at line 207 of file otbStreamingMinMaxImageFilter.h.

◆ Superclass

template<class TInputImage >
typedef PersistentFilterStreamingDecorator<PersistentMinMaxImageFilter<TInputImage> > otb::StreamingMinMaxImageFilter< TInputImage >::Superclass

Definition at line 199 of file otbStreamingMinMaxImageFilter.h.

Constructor & Destructor Documentation

◆ StreamingMinMaxImageFilter() [1/2]

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

Constructor

Definition at line 286 of file otbStreamingMinMaxImageFilter.h.

◆ ~StreamingMinMaxImageFilter()

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

Destructor

Definition at line 291 of file otbStreamingMinMaxImageFilter.h.

◆ StreamingMinMaxImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetInput()

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

Definition at line 221 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximum()

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

Return the computed Maximum.

Definition at line 241 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximumIndex()

template<class TInputImage >
IndexType otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumIndex ( ) const
inline

Return the computed Maximum.

Definition at line 270 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximumIndexOutput() [1/2]

template<class TInputImage >
IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumIndexOutput ( )
inline

Return the computed Maximum.

Definition at line 274 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximumIndexOutput() [2/2]

template<class TInputImage >
const IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumIndexOutput ( ) const
inline

Return the computed Maximum.

Definition at line 278 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximumOutput() [1/2]

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

Return the computed Maximum.

Definition at line 245 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximumOutput() [2/2]

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

Return the computed Maximum.

Definition at line 249 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimum()

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

Return the computed Minimum.

Definition at line 227 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimumIndex()

template<class TInputImage >
IndexType otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumIndex ( ) const
inline

Return the computed Minimum.

Definition at line 256 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimumIndexOutput() [1/2]

template<class TInputImage >
IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumIndexOutput ( )
inline

Definition at line 260 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimumIndexOutput() [2/2]

template<class TInputImage >
const IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumIndexOutput ( ) const
inline

Definition at line 264 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimumOutput() [1/2]

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

Definition at line 231 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimumOutput() [2/2]

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

Definition at line 235 of file otbStreamingMinMaxImageFilter.h.

◆ GetNameOfClass()

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

Creation through object factory macro

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

◆ New()

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

◆ operator=()

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

◆ SetInput()

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

Definition at line 217 of file otbStreamingMinMaxImageFilter.h.


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