OTB  7.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbMaximumAutocorrelationFactorImageFilter.h>

+ Inheritance diagram for otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef CovarianceEstimatorType::Pointer CovarianceEstimatorPointer
 
typedef StreamingStatisticsVectorImageFilter< InternalImageTypeCovarianceEstimatorType
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef InputImageRegionType::IndexType InputImageIndexType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageRegionType::SizeType InputImageSizeType
 
typedef TInputImage InputImageType
 
typedef InputImageType::ValueType InputImageValueType
 
typedef InputImageType::InternalPixelType InputInternalPixelType
 
typedef VectorImage< InternalPixelType, 2 > InternalImageType
 
typedef MatrixType::InternalMatrixType InternalMatrixType
 
typedef itk::NumericTraits< InputInternalPixelType >::RealType InternalPixelType
 
typedef CovarianceEstimatorType::MatrixObjectType MatrixObjectType
 
typedef MatrixObjectType::ComponentType MatrixType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef VectorType::ValueType RealType
 
typedef MaximumAutocorrelationFactorImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 
typedef CovarianceEstimatorType::RealPixelType VectorType
 
typedef vnl_matrix< RealTypeVnlMatrixType
 
typedef vnl_vector< RealTypeVnlVectorType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual VnlVectorType GetAutoCorrelation ()
 
virtual const char * GetNameOfClass () const
 
virtual VnlMatrixType GetV ()
 
 itkGetObjectMacro (CovarianceEstimator, CovarianceEstimatorType)
 
 itkGetObjectMacro (CovarianceEstimatorH, CovarianceEstimatorType)
 
 itkGetObjectMacro (CovarianceEstimatorV, CovarianceEstimatorType)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void GenerateOutputInformation () override
 
 MaximumAutocorrelationFactorImageFilter ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 ~MaximumAutocorrelationFactorImageFilter () override
 

Private Member Functions

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

Private Attributes

VnlVectorType m_AutoCorrelation
 
CovarianceEstimatorPointer m_CovarianceEstimator
 
CovarianceEstimatorPointer m_CovarianceEstimatorH
 
CovarianceEstimatorPointer m_CovarianceEstimatorV
 
VnlVectorType m_Mean
 
VnlMatrixType m_V
 

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >

This filter implements the Maximum Autocorrelation Factor.

This filter implements the Maximum Autocorrelation Factor, based on the following work:

A. A. Nielsen, "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

Maximum Autocorrelation Factor can be considered as a spatial extension of the PCA, in which new variates try to maximize auto-correlation between neighboring pixels instead of variance. Though the inverse transform can be computed, this filter only provides the forward transform for now.

The GetV() method allows retrieving the linear combinations used to generate new variates, and the GetAutoCorrelation() method allows retrieving the auto-correlation associated to each variate.

This filter has been implemented from the Matlab code kindly made available by the authors here: http://www2.imm.dtu.dk/~aa/software.html

this filter have been validated by comparing the output image to the output produced by the Matlab code, and the reference image for testing has been generated from the Matlab code using Octave.

,

See also
otbPCAImageFilter

Definition at line 69 of file otbMaximumAutocorrelationFactorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 76 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ CovarianceEstimatorPointer

template<class TInputImage , class TOutputImage >
typedef CovarianceEstimatorType::Pointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::CovarianceEstimatorPointer

◆ CovarianceEstimatorType

template<class TInputImage , class TOutputImage >
typedef StreamingStatisticsVectorImageFilter<InternalImageType> otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::CovarianceEstimatorType

Internal filters types

Definition at line 104 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImageConstPointer

template<class TInputImage , class TOutputImage >
typedef InputImageType::ConstPointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Definition at line 87 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImageIndexType

template<class TInputImage , class TOutputImage >
typedef InputImageRegionType::IndexType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImageIndexType

Definition at line 90 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImagePixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 91 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImagePointer

template<class TInputImage , class TOutputImage >
typedef InputImageType::Pointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 86 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 88 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImageSizeType

template<class TInputImage , class TOutputImage >
typedef InputImageRegionType::SizeType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Definition at line 89 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >
typedef TInputImage otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 82 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputImageValueType

template<class TInputImage , class TOutputImage >
typedef InputImageType::ValueType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputImageValueType

Definition at line 92 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InputInternalPixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::InternalPixelType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

Definition at line 97 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ InternalImageType

template<class TInputImage , class TOutputImage >
typedef VectorImage<InternalPixelType, 2> otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InternalImageType

◆ InternalMatrixType

template<class TInputImage , class TOutputImage >
typedef MatrixType::InternalMatrixType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InternalMatrixType

◆ InternalPixelType

template<class TInputImage , class TOutputImage >
typedef itk::NumericTraits<InputInternalPixelType>::RealType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::InternalPixelType

Definition at line 98 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ MatrixObjectType

template<class TInputImage , class TOutputImage >
typedef CovarianceEstimatorType::MatrixObjectType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::MatrixObjectType

◆ MatrixType

template<class TInputImage , class TOutputImage >
typedef MatrixObjectType::ComponentType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::MatrixType

◆ OutputImagePixelType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Definition at line 96 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ OutputImagePointer

template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 94 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 95 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >
typedef TOutputImage otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 93 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<Self> otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 75 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ RealType

template<class TInputImage , class TOutputImage >
typedef VectorType::ValueType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::RealType

◆ Self

template<class TInputImage , class TOutputImage >
typedef MaximumAutocorrelationFactorImageFilter otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 73 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 74 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ VectorType

template<class TInputImage , class TOutputImage >
typedef CovarianceEstimatorType::RealPixelType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::VectorType

◆ VnlMatrixType

template<class TInputImage , class TOutputImage >
typedef vnl_matrix<RealType> otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::VnlMatrixType

◆ VnlVectorType

template<class TInputImage , class TOutputImage >
typedef vnl_vector<RealType> otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::VnlVectorType

Constructor & Destructor Documentation

◆ MaximumAutocorrelationFactorImageFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::MaximumAutocorrelationFactorImageFilter ( )
protected

◆ ~MaximumAutocorrelationFactorImageFilter()

template<class TInputImage , class TOutputImage >
otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::~MaximumAutocorrelationFactorImageFilter ( )
inlineoverrideprotected

◆ MaximumAutocorrelationFactorImageFilter() [2/2]

template<class TInputImage , class TOutputImage >
otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::MaximumAutocorrelationFactorImageFilter ( const Self )
privatedelete

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >
void otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( void  )
overrideprotected

◆ GetAutoCorrelation()

template<class TInputImage , class TOutputImage >
virtual VnlVectorType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::GetAutoCorrelation ( )
virtual

Get the auto-correlation associated with each Maf

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >
virtual const char* otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetV()

template<class TInputImage , class TOutputImage >
virtual VnlMatrixType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::GetV ( )
virtual

Get the linear combination used to compute Maf

◆ itkGetObjectMacro() [1/3]

template<class TInputImage , class TOutputImage >
otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::itkGetObjectMacro ( CovarianceEstimator  ,
CovarianceEstimatorType   
)

Get the covariance estimator for image (use for progress reporting purposes)

◆ itkGetObjectMacro() [2/3]

template<class TInputImage , class TOutputImage >
otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::itkGetObjectMacro ( CovarianceEstimatorH  ,
CovarianceEstimatorType   
)

Get the covariance estimator for horizontal autocorrelation (use for progress reporting purposes)

◆ itkGetObjectMacro() [3/3]

template<class TInputImage , class TOutputImage >
otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::itkGetObjectMacro ( CovarianceEstimatorV  ,
CovarianceEstimatorType   
)

Get the covariance estimator for vertical autocorrelation (use for progress reporting purposes)

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage >
void otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
privatedelete

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Member Data Documentation

◆ m_AutoCorrelation

template<class TInputImage , class TOutputImage >
VnlVectorType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::m_AutoCorrelation
private

The auto-correlation associated with each Maf

Definition at line 165 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ m_CovarianceEstimator

template<class TInputImage , class TOutputImage >
CovarianceEstimatorPointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::m_CovarianceEstimator
private

The covariance estimator for the image

Definition at line 148 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ m_CovarianceEstimatorH

template<class TInputImage , class TOutputImage >
CovarianceEstimatorPointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::m_CovarianceEstimatorH
private

The covariance estimator for auto-correlation in horizontal direction

Definition at line 152 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ m_CovarianceEstimatorV

template<class TInputImage , class TOutputImage >
CovarianceEstimatorPointer otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::m_CovarianceEstimatorV
private

The covariance estimator for auto-correlation in vertical direction

Definition at line 156 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ m_Mean

template<class TInputImage , class TOutputImage >
VnlVectorType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::m_Mean
private

The mean used to center data before computing Maf

Definition at line 162 of file otbMaximumAutocorrelationFactorImageFilter.h.

◆ m_V

template<class TInputImage , class TOutputImage >
VnlMatrixType otb::MaximumAutocorrelationFactorImageFilter< TInputImage, TOutputImage >::m_V
private

The linear combination for Maf

Definition at line 159 of file otbMaximumAutocorrelationFactorImageFilter.h.


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