Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::PersistentInnerProductVectorImageFilter< TInputImage > Class Template Reference

Compute the inner product of a large image using streaming. More...

#include <otbStreamingInnerProductVectorImageFilter.h>

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

Public Types

typedef std::vector< MatrixTypeArrayMatrixType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef TInputImage ImageType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef
itk::SimpleDataObjectDecorator
< MatrixType
MatrixObjectType
 
typedef vnl_matrix< double > MatrixType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
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< SelfPointer
 
typedef PersistentImageFilter Self
 
typedef
itk::ImageToImageFilter
< TInputImage, TInputImage > 
Superclass
 

Public Member Functions

virtual void AllocateOutputs ()
 
virtual void CenterDataOff ()
 
virtual void CenterDataOn ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateOutputInformation ()
 
virtual bool GetCenterData ()
 
MatrixType GetInnerProduct () const
 
MatrixObjectTypeGetInnerProductOutput ()
 
const MatrixObjectTypeGetInnerProductOutput () const
 
virtual const char * GetNameOfClass () const
 
virtual DataObjectPointer MakeOutput (unsigned int idx)
 
virtual void Reset (void)
 
virtual void SetCenterData (bool _arg)
 
virtual void Synthetize (void)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Member Functions

 PersistentInnerProductVectorImageFilter ()
 
virtual ~PersistentInnerProductVectorImageFilter ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId)
 
- Protected Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
 PersistentImageFilter ()
 
virtual ~PersistentImageFilter ()
 

Private Member Functions

 PersistentInnerProductVectorImageFilter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

bool m_CenterData
 
ArrayMatrixType m_ThreadInnerProduct
 

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 statitics 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 otbStreamingInnerProductVectorImageFilter.h.

Member Typedef Documentation

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

Definition at line 86 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 62 of file otbStreamingInnerProductVectorImageFilter.h.

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.

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

Image related typedefs.

Definition at line 68 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 72 of file otbStreamingInnerProductVectorImageFilter.h.

Type of DataObjects used for scalar outputs

Definition at line 89 of file otbStreamingInnerProductVectorImageFilter.h.

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

Type definition for a double matrix.

Definition at line 85 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 74 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 61 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 73 of file otbStreamingInnerProductVectorImageFilter.h.

Standard Self typedef

Definition at line 59 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 60 of file otbStreamingInnerProductVectorImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage >
otb::PersistentInnerProductVectorImageFilter< TInputImage >::PersistentInnerProductVectorImageFilter ( )
protected
template<class TInputImage >
virtual otb::PersistentInnerProductVectorImageFilter< TInputImage >::~PersistentInnerProductVectorImageFilter ( )
inlineprotectedvirtual

Definition at line 120 of file otbStreamingInnerProductVectorImageFilter.h.

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

Member Function Documentation

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

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

Definition at line 111 of file otbStreamingInnerProductVectorImageFilter.txx.

template<class TInputImage >
virtual void otb::PersistentInnerProductVectorImageFilter< TInputImage >::CenterDataOff ( )
virtual
template<class TInputImage >
virtual void otb::PersistentInnerProductVectorImageFilter< TInputImage >::CenterDataOn ( )
virtual
template<class TInputImage >
virtual::itk::LightObject::Pointer otb::PersistentInnerProductVectorImageFilter< TInputImage >::CreateAnother ( void  ) const
template<class TInputImage >
void otb::PersistentInnerProductVectorImageFilter< TInputImage >::GenerateOutputInformation ( void  )
virtual
template<class TInputImage >
virtual bool otb::PersistentInnerProductVectorImageFilter< TInputImage >::GetCenterData ( )
virtual
template<class TInputImage >
MatrixType otb::PersistentInnerProductVectorImageFilter< TInputImage >::GetInnerProduct ( ) const
inline

Return the computed inner product matrix.

Definition at line 93 of file otbStreamingInnerProductVectorImageFilter.h.

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

Runtime information support.

Reimplemented from otb::PersistentImageFilter< TInputImage, TInputImage >.

template<class TInputImage >
itk::DataObject::Pointer otb::PersistentInnerProductVectorImageFilter< TInputImage >::MakeOutput ( unsigned int  idx)
virtual

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

Definition at line 57 of file otbStreamingInnerProductVectorImageFilter.txx.

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

Method for creation through the object factory.

template<class TInputImage >
void otb::PersistentInnerProductVectorImageFilter< TInputImage >::operator= ( const Self )
private
template<class TImage >
void otb::PersistentInnerProductVectorImageFilter< TImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

PrintSelf method

Reimplemented from otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 257 of file otbStreamingInnerProductVectorImageFilter.txx.

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

Reset the persistent data of the filter.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 123 of file otbStreamingInnerProductVectorImageFilter.txx.

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

Enable/Disable center data

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

Synthesize the persistent data of the filter.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 151 of file otbStreamingInnerProductVectorImageFilter.txx.

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

Member Data Documentation

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

Image related typedefs.

Definition at line 79 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 76 of file otbStreamingInnerProductVectorImageFilter.h.

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

Enable/Disable center data

Definition at line 132 of file otbStreamingInnerProductVectorImageFilter.h.

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

Definition at line 129 of file otbStreamingInnerProductVectorImageFilter.h.


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