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

#include <otbVectorImageToMatrixImageFilter.h>

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

Public Types

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 vnl_matrix< RealType > MatrixType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::VariableLengthVector< RealType > RealPixelType
 
typedef InternalPixelType RealType
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentVectorImageToMatrixFilter 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
 
MatrixObjectType * GetMatrixOutput ()
 
const MatrixObjectType * GetMatrixOutput () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 
void Synthetize (void) override
 
void Reset (void) override
 
 PersistentVectorImageToMatrixFilter ()
 
 ~PersistentVectorImageToMatrixFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 PersistentVectorImageToMatrixFilter (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::PersistentVectorImageToMatrixFilter< TInputImage >

Compute covariance & correlation 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 otbVectorImageToMatrixImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 61 of file otbVectorImageToMatrixImageFilter.h.

◆ DataObjectPointer

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

Smart Pointer type to a DataObject.

Definition at line 89 of file otbVectorImageToMatrixImageFilter.h.

◆ DataObjectPointerArraySizeType

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

Definition at line 90 of file otbVectorImageToMatrixImageFilter.h.

◆ ImageType

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

Image related typedefs.

Definition at line 67 of file otbVectorImageToMatrixImageFilter.h.

◆ IndexType

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

Definition at line 74 of file otbVectorImageToMatrixImageFilter.h.

◆ InputImagePointer

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

Definition at line 71 of file otbVectorImageToMatrixImageFilter.h.

◆ InternalPixelType

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

Definition at line 76 of file otbVectorImageToMatrixImageFilter.h.

◆ MatrixObjectType

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

Definition at line 94 of file otbVectorImageToMatrixImageFilter.h.

◆ MatrixType

template<class TInputImage >
typedef vnl_matrix<RealType> otb::PersistentVectorImageToMatrixFilter< TInputImage >::MatrixType

Type of DataObjects used for scalar outputs

Definition at line 93 of file otbVectorImageToMatrixImageFilter.h.

◆ PixelType

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

Definition at line 75 of file otbVectorImageToMatrixImageFilter.h.

◆ Pointer

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

Definition at line 60 of file otbVectorImageToMatrixImageFilter.h.

◆ RealPixelType

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

Definition at line 86 of file otbVectorImageToMatrixImageFilter.h.

◆ RealType

template<class TInputImage >
typedef InternalPixelType otb::PersistentVectorImageToMatrixFilter< TInputImage >::RealType

Type to use for computations.

Definition at line 85 of file otbVectorImageToMatrixImageFilter.h.

◆ RegionType

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

Definition at line 72 of file otbVectorImageToMatrixImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 58 of file otbVectorImageToMatrixImageFilter.h.

◆ SizeType

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

Definition at line 73 of file otbVectorImageToMatrixImageFilter.h.

◆ Superclass

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

Definition at line 59 of file otbVectorImageToMatrixImageFilter.h.

Constructor & Destructor Documentation

◆ PersistentVectorImageToMatrixFilter() [1/2]

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

Return the computed matrix as a DataObject

Definition at line 35 of file otbVectorImageToMatrixImageFilter.hxx.

◆ ~PersistentVectorImageToMatrixFilter()

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

Return the computed matrix as a DataObject

Definition at line 118 of file otbVectorImageToMatrixImageFilter.h.

◆ PersistentVectorImageToMatrixFilter() [2/2]

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

Return the computed matrix as a DataObject

Member Function Documentation

◆ AllocateOutputs()

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

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

Definition at line 92 of file otbVectorImageToMatrixImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateOutputInformation()

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

Return the computed matrix as a DataObject

Definition at line 76 of file otbVectorImageToMatrixImageFilter.hxx.

◆ GetMatrixOutput() [1/2]

template<class TInputImage >
const PersistentVectorImageToMatrixFilter< TInputImage >::MatrixObjectType * otb::PersistentVectorImageToMatrixFilter< TInputImage >::GetMatrixOutput

Return the computed matrix as a DataObject

Definition at line 64 of file otbVectorImageToMatrixImageFilter.hxx.

◆ GetMatrixOutput() [2/2]

template<class TInputImage >
const MatrixObjectType* otb::PersistentVectorImageToMatrixFilter< TInputImage >::GetMatrixOutput ( ) const

Return the computed matrix as a DataObject

◆ GetNameOfClass()

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

Runtime information support.

◆ MakeOutput()

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

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

Definition at line 46 of file otbVectorImageToMatrixImageFilter.hxx.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Return the computed matrix as a DataObject

◆ PrintSelf()

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

Return the computed matrix as a DataObject

Definition at line 141 of file otbVectorImageToMatrixImageFilter.hxx.

◆ Reset()

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

Return the computed matrix as a DataObject

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 102 of file otbVectorImageToMatrixImageFilter.hxx.

◆ Synthetize()

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

Return the computed matrix as a DataObject

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 111 of file otbVectorImageToMatrixImageFilter.hxx.

◆ ThreadedGenerateData()

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

Return the computed matrix as a DataObject

Definition at line 116 of file otbVectorImageToMatrixImageFilter.hxx.

Member Data Documentation

◆ ImageDimension

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

Image related typedefs.

Definition at line 81 of file otbVectorImageToMatrixImageFilter.h.

◆ InputImageDimension

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

Definition at line 78 of file otbVectorImageToMatrixImageFilter.h.

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