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

#include <otbStreamingMinMaxVectorImageFilter.h>

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

Public Types

typedef itk::Array< long > ArrayLongPixelType
 
typedef std::vector< MatrixType > ArrayMatrixType
 
typedef std::vector< PixelType > ArrayPixelType
 
typedef std::vector< RealPixelType > ArrayRealPixelType
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef TInputImage::InternalPixelType InternalPixelType
 
typedef itk::SimpleDataObjectDecorator< MatrixType > MatrixObjectType
 
typedef itk::VariableSizeMatrix< RealType > MatrixType
 
typedef itk::SimpleDataObjectDecorator< PixelType > PixelObjectType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SimpleDataObjectDecorator< RealPixelType > RealPixelObjectType
 
typedef itk::VariableLengthVector< RealType > RealPixelType
 
typedef itk::NumericTraits< InternalPixelType >::RealType RealType
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentMinMaxVectorImageFilter 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
 
virtual bool GetNoDataFlag ()
 
virtual const InternalPixelType & GetNoDataValue () const
 
virtual void NoDataFlagOff ()
 
virtual void NoDataFlagOn ()
 
virtual void SetNoDataFlag (bool _arg)
 
virtual void SetNoDataValue (InternalPixelType _arg)
 
- 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
 
ArrayPixelType m_ThreadMin
 
ArrayPixelType m_ThreadMax
 
bool m_NoDataFlag
 
InternalPixelType m_NoDataValue
 
PixelType GetMinimum () const
 
PixelObjectType * GetMinimumOutput ()
 
const PixelObjectType * GetMinimumOutput () const
 
PixelType GetMaximum () const
 
PixelObjectType * GetMaximumOutput ()
 
const PixelObjectType * GetMaximumOutput () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 
void Synthetize (void) override
 
void Reset (void) override
 
 PersistentMinMaxVectorImageFilter ()
 
 ~PersistentMinMaxVectorImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 PersistentMinMaxVectorImageFilter (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::PersistentMinMaxVectorImageFilter< TInputImage >

Compute min. max of a large image using streaming.

This filter persists its temporary data. It means that if you Update it n times on n different requested regions, the output statistics 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 statistics once the regions have been processed via the pipeline, use the Synthetize() method.

See also
PersistentImageFilter

Definition at line 54 of file otbStreamingMinMaxVectorImageFilter.h.

Member Typedef Documentation

◆ ArrayLongPixelType

template<class TInputImage >
typedef itk::Array<long> otb::PersistentMinMaxVectorImageFilter< TInputImage >::ArrayLongPixelType

Definition at line 94 of file otbStreamingMinMaxVectorImageFilter.h.

◆ ArrayMatrixType

template<class TInputImage >
typedef std::vector<MatrixType> otb::PersistentMinMaxVectorImageFilter< TInputImage >::ArrayMatrixType

Definition at line 93 of file otbStreamingMinMaxVectorImageFilter.h.

◆ ArrayPixelType

template<class TInputImage >
typedef std::vector<PixelType> otb::PersistentMinMaxVectorImageFilter< TInputImage >::ArrayPixelType

Definition at line 96 of file otbStreamingMinMaxVectorImageFilter.h.

◆ ArrayRealPixelType

template<class TInputImage >
typedef std::vector<RealPixelType> otb::PersistentMinMaxVectorImageFilter< TInputImage >::ArrayRealPixelType

Definition at line 95 of file otbStreamingMinMaxVectorImageFilter.h.

◆ ConstPointer

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

Definition at line 61 of file otbStreamingMinMaxVectorImageFilter.h.

◆ DataObjectPointer

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

Smart Pointer type to a DataObject.

Definition at line 88 of file otbStreamingMinMaxVectorImageFilter.h.

◆ DataObjectPointerArraySizeType

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

Definition at line 89 of file otbStreamingMinMaxVectorImageFilter.h.

◆ ImageType

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

Image related typedefs.

Definition at line 67 of file otbStreamingMinMaxVectorImageFilter.h.

◆ IndexType

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

Definition at line 74 of file otbStreamingMinMaxVectorImageFilter.h.

◆ InputImagePointer

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

Definition at line 71 of file otbStreamingMinMaxVectorImageFilter.h.

◆ InternalPixelType

template<class TInputImage >
typedef TInputImage::InternalPixelType otb::PersistentMinMaxVectorImageFilter< TInputImage >::InternalPixelType

Definition at line 76 of file otbStreamingMinMaxVectorImageFilter.h.

◆ MatrixObjectType

template<class TInputImage >
typedef itk::SimpleDataObjectDecorator<MatrixType> otb::PersistentMinMaxVectorImageFilter< TInputImage >::MatrixObjectType

Definition at line 99 of file otbStreamingMinMaxVectorImageFilter.h.

◆ MatrixType

template<class TInputImage >
typedef itk::VariableSizeMatrix<RealType> otb::PersistentMinMaxVectorImageFilter< TInputImage >::MatrixType

Type of DataObjects used for scalar outputs

Definition at line 92 of file otbStreamingMinMaxVectorImageFilter.h.

◆ PixelObjectType

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

Definition at line 98 of file otbStreamingMinMaxVectorImageFilter.h.

◆ PixelType

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

Definition at line 75 of file otbStreamingMinMaxVectorImageFilter.h.

◆ Pointer

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

Definition at line 60 of file otbStreamingMinMaxVectorImageFilter.h.

◆ RealPixelObjectType

template<class TInputImage >
typedef itk::SimpleDataObjectDecorator<RealPixelType> otb::PersistentMinMaxVectorImageFilter< TInputImage >::RealPixelObjectType

Definition at line 97 of file otbStreamingMinMaxVectorImageFilter.h.

◆ RealPixelType

template<class TInputImage >
typedef itk::VariableLengthVector<RealType> otb::PersistentMinMaxVectorImageFilter< TInputImage >::RealPixelType

Definition at line 85 of file otbStreamingMinMaxVectorImageFilter.h.

◆ RealType

template<class TInputImage >
typedef itk::NumericTraits<InternalPixelType>::RealType otb::PersistentMinMaxVectorImageFilter< TInputImage >::RealType

Type to use for computations.

Definition at line 84 of file otbStreamingMinMaxVectorImageFilter.h.

◆ RegionType

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

Definition at line 72 of file otbStreamingMinMaxVectorImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 58 of file otbStreamingMinMaxVectorImageFilter.h.

◆ SizeType

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

Definition at line 73 of file otbStreamingMinMaxVectorImageFilter.h.

◆ Superclass

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

Definition at line 59 of file otbStreamingMinMaxVectorImageFilter.h.

Constructor & Destructor Documentation

◆ PersistentMinMaxVectorImageFilter() [1/2]

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

Return the computed Minimum.

Definition at line 36 of file otbStreamingMinMaxVectorImageFilter.hxx.

References otb::PersistentMinMaxVectorImageFilter< TInputImage >::MakeOutput().

◆ ~PersistentMinMaxVectorImageFilter()

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

Return the computed Minimum.

Definition at line 162 of file otbStreamingMinMaxVectorImageFilter.h.

◆ PersistentMinMaxVectorImageFilter() [2/2]

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

Return the computed Minimum.

Member Function Documentation

◆ AllocateOutputs()

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

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

Definition at line 110 of file otbStreamingMinMaxVectorImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateOutputInformation()

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

Return the computed Minimum.

Definition at line 94 of file otbStreamingMinMaxVectorImageFilter.hxx.

◆ GetMaximum()

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

Return the computed Maximum.

Definition at line 137 of file otbStreamingMinMaxVectorImageFilter.h.

◆ GetMaximumOutput() [1/2]

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

Return the computed Minimum.

Definition at line 82 of file otbStreamingMinMaxVectorImageFilter.hxx.

◆ GetMaximumOutput() [2/2]

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

Return the computed Minimum.

◆ GetMinimum()

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

Return the computed Minimum.

Definition at line 128 of file otbStreamingMinMaxVectorImageFilter.h.

◆ GetMinimumOutput() [1/2]

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

Return the computed Minimum.

Definition at line 70 of file otbStreamingMinMaxVectorImageFilter.hxx.

◆ GetMinimumOutput() [2/2]

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

Return the computed Minimum.

◆ GetNameOfClass()

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

Runtime information support.

◆ GetNoDataFlag()

template<class TInputImage >
virtual bool otb::PersistentMinMaxVectorImageFilter< TInputImage >::GetNoDataFlag ( )
virtual

Get the NoDataFlag. If set to true, samples with values equal to m_NoDataValue are ignored.

◆ GetNoDataValue()

template<class TInputImage >
virtual const InternalPixelType& otb::PersistentMinMaxVectorImageFilter< TInputImage >::GetNoDataValue ( ) const
virtual

Set the no data value. These value are ignored in histogram computation if NoDataFlag is On

◆ MakeOutput()

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

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

Definition at line 53 of file otbStreamingMinMaxVectorImageFilter.hxx.

Referenced by otb::PersistentMinMaxVectorImageFilter< TInputImage >::PersistentMinMaxVectorImageFilter().

◆ New()

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

Method for creation through the object factory.

◆ NoDataFlagOff()

template<class TInputImage >
virtual void otb::PersistentMinMaxVectorImageFilter< TInputImage >::NoDataFlagOff ( )
virtual

◆ NoDataFlagOn()

template<class TInputImage >
virtual void otb::PersistentMinMaxVectorImageFilter< TInputImage >::NoDataFlagOn ( )
virtual

Toggle the NoDataFlag. If set to true, samples with values equal to m_NoDataValue are ignored.

◆ operator=()

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

Return the computed Minimum.

◆ PrintSelf()

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

Return the computed Minimum.

Definition at line 225 of file otbStreamingMinMaxVectorImageFilter.hxx.

◆ Reset()

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

Return the computed Minimum.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 120 of file otbStreamingMinMaxVectorImageFilter.hxx.

◆ SetNoDataFlag()

template<class TInputImage >
virtual void otb::PersistentMinMaxVectorImageFilter< TInputImage >::SetNoDataFlag ( bool  _arg)
virtual

Set the NoDataFlag. If set to true, samples with values equal to m_NoDataValue are ignored.

◆ SetNoDataValue()

template<class TInputImage >
virtual void otb::PersistentMinMaxVectorImageFilter< TInputImage >::SetNoDataValue ( InternalPixelType  _arg)
virtual

Set the no data value. These value are ignored in histogram computation if NoDataFlag is On

◆ Synthetize()

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

Return the computed Minimum.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 147 of file otbStreamingMinMaxVectorImageFilter.hxx.

◆ ThreadedGenerateData()

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

Multi-thread version GenerateData.

Grab the input

Definition at line 185 of file otbStreamingMinMaxVectorImageFilter.hxx.

Member Data Documentation

◆ ImageDimension

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

Image related typedefs.

Definition at line 81 of file otbStreamingMinMaxVectorImageFilter.h.

◆ InputImageDimension

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

Definition at line 78 of file otbStreamingMinMaxVectorImageFilter.h.

◆ m_NoDataFlag

template<class TInputImage >
bool otb::PersistentMinMaxVectorImageFilter< TInputImage >::m_NoDataFlag
private

Return the computed Minimum.

Definition at line 175 of file otbStreamingMinMaxVectorImageFilter.h.

◆ m_NoDataValue

template<class TInputImage >
InternalPixelType otb::PersistentMinMaxVectorImageFilter< TInputImage >::m_NoDataValue
private

Return the computed Minimum.

Definition at line 176 of file otbStreamingMinMaxVectorImageFilter.h.

◆ m_ThreadMax

template<class TInputImage >
ArrayPixelType otb::PersistentMinMaxVectorImageFilter< TInputImage >::m_ThreadMax
private

Return the computed Minimum.

Definition at line 174 of file otbStreamingMinMaxVectorImageFilter.h.

◆ m_ThreadMin

template<class TInputImage >
ArrayPixelType otb::PersistentMinMaxVectorImageFilter< TInputImage >::m_ThreadMin
private

Return the computed Minimum.

Definition at line 173 of file otbStreamingMinMaxVectorImageFilter.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