OTB  7.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > Class Template Reference

#include <otbStreamingMatrixTransposeMatrixImageFilter.h>

+ Inheritance diagram for otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >:
+ Collaboration diagram for otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TInputImage1 InputImage1Type
 
typedef TInputImage2 InputImage2Type
 
typedef itk::SimpleDataObjectDecorator< MatrixTypeMatrixObjectType
 
typedef Superclass::FilterType MatrixToTransposeMatrixFilterType
 
typedef MatrixToTransposeMatrixFilterType::MatrixType MatrixType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StreamingMatrixTransposeMatrixImageFilter Self
 
typedef PersistentFilterStreamingDecorator< PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > > Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > FilterType
 
typedef FilterType::InputImageType ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PersistentFilterStreamingDecorator Self
 
typedef StreamerType::Pointer StreamerPointerType
 
typedef StreamingImageVirtualWriter< ImageTypeStreamerType
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
bool GetUsePadFirstInput (void)
 
bool GetUsePadSecondInput (void)
 
void SetFirstInput (InputImage1Type *input1)
 
void SetSecondInput (InputImage2Type *input2)
 
void SetUsePadFirstInput (bool pad)
 
void SetUsePadSecondInput (bool pad)
 
MatrixType GetResult (void) const
 
MatrixObjectTypeGetResultOutput (void)
 
const MatrixObjectTypeGetResultOutput () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const FilterTypeGetFilter () const
 
 itkGetObjectMacro (Filter, FilterType)
 
 itkGetObjectMacro (Streamer, StreamerType)
 
virtual void SetFilter (FilterType *_arg)
 
void Update (void) override
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > >
static Pointer New ()
 

Protected Member Functions

 StreamingMatrixTransposeMatrixImageFilter ()
 
 ~StreamingMatrixTransposeMatrixImageFilter () override
 
- Protected Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > >
void GenerateData (void) override
 
 PersistentFilterStreamingDecorator ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentFilterStreamingDecorator () override
 

Private Member Functions

void operator= (const Self &)=delete
 
 StreamingMatrixTransposeMatrixImageFilter (const Self &)=delete
 

Additional Inherited Members

- Protected Attributes inherited from otb::PersistentFilterStreamingDecorator< PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > >
FilterPointerType m_Filter
 
StreamerPointerType m_Streamer
 

Detailed Description

template<class TInputImage1, class TInputImage2>
class otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >

This class streams the whole input image through the PersistentMatrixTransposeMatrixImageFilter.

=========================================================================== This way, it allows computing

\[X^T.Y \]

where

\[X\]

and

\[Y\]

are the input images. first order global statistics of this image. It calls the Reset() method of the PersistentMatrixTransposeMatrixImageFilter before streaming the image and the Synthetize() method of the PersistentMatrixTransposeMatrixImageFilter after having streamed the image to compute the statistics. The accessor on the results are wrapping the accessors of the internal PersistentStatisticsImageFilter. The accessor on the pad options are also provided.

See also
PersistentMatrixTransposeMatrixImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 216 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage1 , class TInputImage2 >
typedef itk::SmartPointer<const Self> otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::ConstPointer

◆ InputImage1Type

template<class TInputImage1 , class TInputImage2 >
typedef TInputImage1 otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::InputImage1Type

◆ InputImage2Type

template<class TInputImage1 , class TInputImage2 >
typedef TInputImage2 otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::InputImage2Type

◆ MatrixObjectType

template<class TInputImage1 , class TInputImage2 >
typedef itk::SimpleDataObjectDecorator<MatrixType> otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::MatrixObjectType

◆ MatrixToTransposeMatrixFilterType

template<class TInputImage1 , class TInputImage2 >
typedef Superclass::FilterType otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::MatrixToTransposeMatrixFilterType

◆ MatrixType

template<class TInputImage1 , class TInputImage2 >
typedef MatrixToTransposeMatrixFilterType::MatrixType otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::MatrixType

◆ Pointer

template<class TInputImage1 , class TInputImage2 >
typedef itk::SmartPointer<Self> otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::Pointer

◆ Self

template<class TInputImage1 , class TInputImage2 >
typedef StreamingMatrixTransposeMatrixImageFilter otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::Self

Standard Self typedef

Definition at line 221 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

◆ Superclass

template<class TInputImage1 , class TInputImage2 >
typedef PersistentFilterStreamingDecorator<PersistentMatrixTransposeMatrixImageFilter<TInputImage1, TInputImage2> > otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::Superclass

Constructor & Destructor Documentation

◆ StreamingMatrixTransposeMatrixImageFilter() [1/2]

template<class TInputImage1 , class TInputImage2 >
otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::StreamingMatrixTransposeMatrixImageFilter ( )
inlineprotected

Constructor

Definition at line 282 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

◆ ~StreamingMatrixTransposeMatrixImageFilter()

template<class TInputImage1 , class TInputImage2 >
otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::~StreamingMatrixTransposeMatrixImageFilter ( )
inlineoverrideprotected

Destructor

Definition at line 285 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

◆ StreamingMatrixTransposeMatrixImageFilter() [2/2]

template<class TInputImage1 , class TInputImage2 >
otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::StreamingMatrixTransposeMatrixImageFilter ( const Self )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<class TInputImage1 , class TInputImage2 >
virtual::itk::LightObject::Pointer otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::CreateAnother ( void  ) const

◆ GetNameOfClass()

template<class TInputImage1 , class TInputImage2 >
virtual const char* otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::GetNameOfClass ( ) const
virtual

◆ GetResult()

template<class TInputImage1 , class TInputImage2 >
MatrixType otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::GetResult ( void  ) const
inline

Return the computed transpose(Image1)*Image2.

Definition at line 266 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

◆ GetResultOutput() [1/2]

template<class TInputImage1 , class TInputImage2 >
MatrixObjectType* otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::GetResultOutput ( void  )
inline

Return the computed transpose(Image1)*Image2.

Definition at line 270 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

◆ GetResultOutput() [2/2]

template<class TInputImage1 , class TInputImage2 >
const MatrixObjectType* otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::GetResultOutput ( void  ) const
inline

Return the computed transpose(Image1)*Image2.

Definition at line 274 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

◆ GetUsePadFirstInput()

template<class TInputImage1 , class TInputImage2 >
bool otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::GetUsePadFirstInput ( void  )
inline

◆ GetUsePadSecondInput()

template<class TInputImage1 , class TInputImage2 >
bool otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::GetUsePadSecondInput ( void  )
inline

◆ New()

template<class TInputImage1 , class TInputImage2 >
static Pointer otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::New ( )
static

Type macro

◆ operator=()

template<class TInputImage1 , class TInputImage2 >
void otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::operator= ( const Self )
privatedelete

◆ SetFirstInput()

template<class TInputImage1 , class TInputImage2 >
void otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::SetFirstInput ( InputImage1Type input1)
inline

Interfaces to the embedded filter

Definition at line 240 of file otbStreamingMatrixTransposeMatrixImageFilter.h.

◆ SetSecondInput()

template<class TInputImage1 , class TInputImage2 >
void otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::SetSecondInput ( InputImage2Type input2)
inline

◆ SetUsePadFirstInput()

template<class TInputImage1 , class TInputImage2 >
void otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::SetUsePadFirstInput ( bool  pad)
inline

◆ SetUsePadSecondInput()

template<class TInputImage1 , class TInputImage2 >
void otb::StreamingMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 >::SetUsePadSecondInput ( bool  pad)
inline

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