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

#include <otbStreamingInnerProductVectorImageFilter.h>

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

Public Types

typedef std::vector< MatrixType > ArrayMatrixType
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef TInputImage ImageType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef itk::SimpleDataObjectDecorator< MatrixType > MatrixObjectType
 
typedef vnl_matrix< double > MatrixType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentInnerProductVectorImageFilter Self
 
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
 
MatrixType GetInnerProduct () const
 
MatrixObjectType * GetInnerProductOutput ()
 
const MatrixObjectType * GetInnerProductOutput () const
 
virtual const char * GetNameOfClass () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- 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
 
ArrayMatrixType m_ThreadInnerProduct
 
bool m_CenterData
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 
void Synthetize (void) override
 
void Reset (void) override
 
virtual void SetCenterData (bool _arg)
 
virtual bool GetCenterData ()
 
virtual void CenterDataOn ()
 
virtual void CenterDataOff ()
 
 PersistentInnerProductVectorImageFilter ()
 
 ~PersistentInnerProductVectorImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 PersistentInnerProductVectorImageFilter (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::PersistentInnerProductVectorImageFilter< TInputImage >

Compute the inner product 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 55 of file otbStreamingInnerProductVectorImageFilter.h.

Member Typedef Documentation

◆ ArrayMatrixType

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

Definition at line 87 of file otbStreamingInnerProductVectorImageFilter.h.

◆ ConstPointer

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

Definition at line 62 of file otbStreamingInnerProductVectorImageFilter.h.

◆ DataObjectPointer

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

Smart Pointer type to a DataObject.

Definition at line 82 of file otbStreamingInnerProductVectorImageFilter.h.

◆ DataObjectPointerArraySizeType

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

Definition at line 83 of file otbStreamingInnerProductVectorImageFilter.h.

◆ ImageType

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

Image related typedefs.

Definition at line 68 of file otbStreamingInnerProductVectorImageFilter.h.

◆ InputImagePointer

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

Definition at line 72 of file otbStreamingInnerProductVectorImageFilter.h.

◆ MatrixObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 90 of file otbStreamingInnerProductVectorImageFilter.h.

◆ MatrixType

template<class TInputImage >
typedef vnl_matrix<double> otb::PersistentInnerProductVectorImageFilter< TInputImage >::MatrixType

Type definition for a double matrix.

Definition at line 86 of file otbStreamingInnerProductVectorImageFilter.h.

◆ PixelType

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

Definition at line 74 of file otbStreamingInnerProductVectorImageFilter.h.

◆ Pointer

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

Definition at line 61 of file otbStreamingInnerProductVectorImageFilter.h.

◆ RegionType

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

Definition at line 73 of file otbStreamingInnerProductVectorImageFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 59 of file otbStreamingInnerProductVectorImageFilter.h.

◆ Superclass

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

Definition at line 60 of file otbStreamingInnerProductVectorImageFilter.h.

Constructor & Destructor Documentation

◆ PersistentInnerProductVectorImageFilter() [1/2]

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

Enable/Disable center data

Definition at line 36 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ ~PersistentInnerProductVectorImageFilter()

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

Enable/Disable center data

Definition at line 124 of file otbStreamingInnerProductVectorImageFilter.h.

◆ PersistentInnerProductVectorImageFilter() [2/2]

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

Enable/Disable center data

Member Function Documentation

◆ AllocateOutputs()

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

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

Definition at line 102 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ CenterDataOff()

template<class TInputImage >
virtual void otb::PersistentInnerProductVectorImageFilter< TInputImage >::CenterDataOff ( )
virtual

Enable/Disable center data

◆ CenterDataOn()

template<class TInputImage >
virtual void otb::PersistentInnerProductVectorImageFilter< TInputImage >::CenterDataOn ( )
virtual

Enable/Disable center data

◆ CreateAnother()

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

◆ GenerateOutputInformation()

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

Enable/Disable center data

Definition at line 86 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ GetCenterData()

template<class TInputImage >
virtual bool otb::PersistentInnerProductVectorImageFilter< TInputImage >::GetCenterData ( )
virtual

Enable/Disable center data

◆ GetInnerProduct()

template<class TInputImage >
MatrixType otb::PersistentInnerProductVectorImageFilter< TInputImage >::GetInnerProduct ( ) const
inline

Return the computed inner product matrix.

Definition at line 94 of file otbStreamingInnerProductVectorImageFilter.h.

◆ GetInnerProductOutput() [1/2]

template<class TInputImage >
const PersistentInnerProductVectorImageFilter< TInputImage >::MatrixObjectType * otb::PersistentInnerProductVectorImageFilter< TInputImage >::GetInnerProductOutput

Definition at line 73 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ GetInnerProductOutput() [2/2]

template<class TInputImage >
const MatrixObjectType* otb::PersistentInnerProductVectorImageFilter< TInputImage >::GetInnerProductOutput ( ) const

◆ GetNameOfClass()

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

Runtime information support.

◆ MakeOutput()

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

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

Definition at line 55 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Enable/Disable center data

◆ PrintSelf()

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

Enable/Disable center data

Definition at line 239 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ Reset()

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

Enable/Disable center data

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 112 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ SetCenterData()

template<class TInputImage >
virtual void otb::PersistentInnerProductVectorImageFilter< TInputImage >::SetCenterData ( bool  _arg)
virtual

Enable/Disable center data

◆ Synthetize()

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

Enable/Disable center data

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 137 of file otbStreamingInnerProductVectorImageFilter.hxx.

◆ ThreadedGenerateData()

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

Multi-thread version GenerateData.

Grab the input

Definition at line 178 of file otbStreamingInnerProductVectorImageFilter.hxx.

Member Data Documentation

◆ ImageDimension

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

Image related typedefs.

Definition at line 79 of file otbStreamingInnerProductVectorImageFilter.h.

◆ InputImageDimension

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

Definition at line 76 of file otbStreamingInnerProductVectorImageFilter.h.

◆ m_CenterData

template<class TInputImage >
bool otb::PersistentInnerProductVectorImageFilter< TInputImage >::m_CenterData
private

Enable/Disable center data

Definition at line 138 of file otbStreamingInnerProductVectorImageFilter.h.

◆ m_ThreadInnerProduct

template<class TInputImage >
ArrayMatrixType otb::PersistentInnerProductVectorImageFilter< TInputImage >::m_ThreadInnerProduct
private

Enable/Disable center data

Definition at line 135 of file otbStreamingInnerProductVectorImageFilter.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