OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::PersistentMinMaxImageFilter< TInputImage > Class Template Reference
Processing images region by region » Filters supporting StreamingSupport for Multithreading » | Multithreaded FiltersGroup Core » | Module OTBStatistics

#include <otbStreamingMinMaxImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef TInputImage ImageType
 
typedef itk::SimpleDataObjectDecorator< IndexType > IndexObjectType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef itk::SimpleDataObjectDecorator< PixelType > PixelObjectType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentMinMaxImageFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef PersistentImageFilter< TInputImage, TInputImage > Superclass
 
- Public Types inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef TInputImage InputImageType
 
typedef TInputImage OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef PersistentImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TInputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
std::vector< PixelType > m_ThreadMin
 
std::vector< PixelType > m_ThreadMax
 
std::vector< IndexType > m_ThreadMinIndex
 
std::vector< IndexType > m_ThreadMaxIndex
 
PixelType GetMinimum () const
 
PixelObjectType * GetMinimumOutput ()
 
const PixelObjectType * GetMinimumOutput () const
 
PixelType GetMaximum () const
 
PixelObjectType * GetMaximumOutput ()
 
const PixelObjectType * GetMaximumOutput () const
 
IndexType GetMinimumIndex () const
 
IndexObjectType * GetMinimumIndexOutput ()
 
const IndexObjectType * GetMinimumIndexOutput () const
 
IndexType GetMaximumIndex () const
 
IndexObjectType * GetMaximumIndexOutput ()
 
const IndexObjectType * GetMaximumIndexOutput () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 
void Synthetize (void) override
 
void Reset (void) override
 
 PersistentMinMaxImageFilter ()
 
 ~PersistentMinMaxImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 PersistentMinMaxImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
 PersistentImageFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentImageFilter () override
 

Detailed Description

template<class TInputImage>
class otb::PersistentMinMaxImageFilter< TInputImage >

Compute min. max of an image using the output requested region.

This filter persists its temporary data. It means that if you Update it n times on n different requested regions, the output min/max will be the statistics of the whole set of n regions.

To reset the temporary data, one should call the Reset() function.

To get the min/max once the regions have been processed via the pipeline, use the Synthetize() method.

See also
PersistentImageFilter

Definition at line 52 of file otbStreamingMinMaxImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 59 of file otbStreamingMinMaxImageFilter.h.

◆ DataObjectPointer

template<class TInputImage >
typedef itk::DataObject::Pointer otb::PersistentMinMaxImageFilter< TInputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 82 of file otbStreamingMinMaxImageFilter.h.

◆ DataObjectPointerArraySizeType

template<class TInputImage >
typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::PersistentMinMaxImageFilter< TInputImage >::DataObjectPointerArraySizeType

Definition at line 83 of file otbStreamingMinMaxImageFilter.h.

◆ ImageType

template<class TInputImage >
typedef TInputImage otb::PersistentMinMaxImageFilter< TInputImage >::ImageType

Image related typedefs.

Definition at line 65 of file otbStreamingMinMaxImageFilter.h.

◆ IndexObjectType

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

Definition at line 87 of file otbStreamingMinMaxImageFilter.h.

◆ IndexType

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

Definition at line 73 of file otbStreamingMinMaxImageFilter.h.

◆ InputImagePointer

template<class TInputImage >
typedef TInputImage::Pointer otb::PersistentMinMaxImageFilter< TInputImage >::InputImagePointer

Definition at line 69 of file otbStreamingMinMaxImageFilter.h.

◆ PixelObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 86 of file otbStreamingMinMaxImageFilter.h.

◆ PixelType

template<class TInputImage >
typedef TInputImage::PixelType otb::PersistentMinMaxImageFilter< TInputImage >::PixelType

Definition at line 74 of file otbStreamingMinMaxImageFilter.h.

◆ Pointer

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

Definition at line 58 of file otbStreamingMinMaxImageFilter.h.

◆ RegionType

template<class TInputImage >
typedef TInputImage::RegionType otb::PersistentMinMaxImageFilter< TInputImage >::RegionType

Definition at line 71 of file otbStreamingMinMaxImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 56 of file otbStreamingMinMaxImageFilter.h.

◆ SizeType

template<class TInputImage >
typedef TInputImage::SizeType otb::PersistentMinMaxImageFilter< TInputImage >::SizeType

Definition at line 72 of file otbStreamingMinMaxImageFilter.h.

◆ Superclass

template<class TInputImage >
typedef PersistentImageFilter<TInputImage, TInputImage> otb::PersistentMinMaxImageFilter< TInputImage >::Superclass

Definition at line 57 of file otbStreamingMinMaxImageFilter.h.

Constructor & Destructor Documentation

◆ PersistentMinMaxImageFilter() [1/2]

template<class TInputImage >
otb::PersistentMinMaxImageFilter< TInputImage >::PersistentMinMaxImageFilter
protected

Return the computed Minimum.

Definition at line 35 of file otbStreamingMinMaxImageFilter.hxx.

◆ ~PersistentMinMaxImageFilter()

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

Return the computed Minimum.

Definition at line 142 of file otbStreamingMinMaxImageFilter.h.

◆ PersistentMinMaxImageFilter() [2/2]

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

Return the computed Minimum.

Member Function Documentation

◆ AllocateOutputs()

template<class TInputImage >
void otb::PersistentMinMaxImageFilter< TInputImage >::AllocateOutputs
override

Pass the input through unmodified. Do this by Grafting in the AllocateOutputs method.

Definition at line 141 of file otbStreamingMinMaxImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage >
void otb::PersistentMinMaxImageFilter< TInputImage >::GenerateOutputInformation
override

Return the computed Minimum.

Definition at line 126 of file otbStreamingMinMaxImageFilter.hxx.

◆ GetMaximum()

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

Return the computed Maximum.

Definition at line 99 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximumIndex()

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

Return the computed Maximum.

Definition at line 117 of file otbStreamingMinMaxImageFilter.h.

◆ GetMaximumIndexOutput() [1/2]

template<class TInputImage >
const PersistentMinMaxImageFilter< TInputImage >::IndexObjectType * otb::PersistentMinMaxImageFilter< TInputImage >::GetMaximumIndexOutput

Return the computed Minimum.

Definition at line 114 of file otbStreamingMinMaxImageFilter.hxx.

◆ GetMaximumIndexOutput() [2/2]

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

Return the computed Minimum.

◆ GetMaximumOutput() [1/2]

template<class TInputImage >
const PersistentMinMaxImageFilter< TInputImage >::PixelObjectType * otb::PersistentMinMaxImageFilter< TInputImage >::GetMaximumOutput

Return the computed Minimum.

Definition at line 89 of file otbStreamingMinMaxImageFilter.hxx.

◆ GetMaximumOutput() [2/2]

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

Return the computed Minimum.

◆ GetMinimum()

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

Return the computed Minimum.

Definition at line 90 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimumIndex()

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

Return the computed Minimum.

Definition at line 108 of file otbStreamingMinMaxImageFilter.h.

◆ GetMinimumIndexOutput() [1/2]

template<class TInputImage >
const PersistentMinMaxImageFilter< TInputImage >::IndexObjectType * otb::PersistentMinMaxImageFilter< TInputImage >::GetMinimumIndexOutput

Return the computed Minimum.

Definition at line 102 of file otbStreamingMinMaxImageFilter.hxx.

◆ GetMinimumIndexOutput() [2/2]

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

Return the computed Minimum.

◆ GetMinimumOutput() [1/2]

template<class TInputImage >
const PersistentMinMaxImageFilter< TInputImage >::PixelObjectType * otb::PersistentMinMaxImageFilter< TInputImage >::GetMinimumOutput

Return the computed Minimum.

Definition at line 77 of file otbStreamingMinMaxImageFilter.hxx.

◆ GetMinimumOutput() [2/2]

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

Return the computed Minimum.

◆ GetNameOfClass()

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

Runtime information support.

◆ MakeOutput()

template<class TInputImage >
itk::DataObject::Pointer otb::PersistentMinMaxImageFilter< TInputImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)
override

Make a DataObject of the correct type to be used as the specified output.

Definition at line 56 of file otbStreamingMinMaxImageFilter.hxx.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Return the computed Minimum.

◆ PrintSelf()

template<class TImage >
void otb::PersistentMinMaxImageFilter< TImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Return the computed Minimum.

Definition at line 229 of file otbStreamingMinMaxImageFilter.hxx.

◆ Reset()

template<class TInputImage >
void otb::PersistentMinMaxImageFilter< TInputImage >::Reset ( void  )
overridevirtual

Return the computed Minimum.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 183 of file otbStreamingMinMaxImageFilter.hxx.

◆ Synthetize()

template<class TInputImage >
void otb::PersistentMinMaxImageFilter< TInputImage >::Synthetize ( void  )
overridevirtual

Return the computed Minimum.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 151 of file otbStreamingMinMaxImageFilter.hxx.

◆ ThreadedGenerateData()

template<class TInputImage >
void otb::PersistentMinMaxImageFilter< TInputImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Multi-thread version GenerateData.

Definition at line 201 of file otbStreamingMinMaxImageFilter.hxx.

Member Data Documentation

◆ ImageDimension

template<class TInputImage >
const unsigned int otb::PersistentMinMaxImageFilter< TInputImage >::ImageDimension = TInputImage::ImageDimension
static

Image related typedefs.

Definition at line 79 of file otbStreamingMinMaxImageFilter.h.

◆ InputImageDimension

template<class TInputImage >
const unsigned int otb::PersistentMinMaxImageFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension
static

Definition at line 76 of file otbStreamingMinMaxImageFilter.h.

◆ m_ThreadMax

template<class TInputImage >
std::vector<PixelType> otb::PersistentMinMaxImageFilter< TInputImage >::m_ThreadMax
private

Return the computed Minimum.

Definition at line 155 of file otbStreamingMinMaxImageFilter.h.

◆ m_ThreadMaxIndex

template<class TInputImage >
std::vector<IndexType> otb::PersistentMinMaxImageFilter< TInputImage >::m_ThreadMaxIndex
private

Return the computed Minimum.

Definition at line 157 of file otbStreamingMinMaxImageFilter.h.

◆ m_ThreadMin

template<class TInputImage >
std::vector<PixelType> otb::PersistentMinMaxImageFilter< TInputImage >::m_ThreadMin
private

Return the computed Minimum.

Definition at line 154 of file otbStreamingMinMaxImageFilter.h.

◆ m_ThreadMinIndex

template<class TInputImage >
std::vector<IndexType> otb::PersistentMinMaxImageFilter< TInputImage >::m_ThreadMinIndex
private

Return the computed Minimum.

Definition at line 156 of file otbStreamingMinMaxImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:20 for OTB with   doxygen 1.8.17