OTB  9.0.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::NormalizeVectorImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbNormalizeVectorImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef CovarianceEstimatorFilterType::Pointer CovarianceEstimatorFilterPointerType
 
typedef StreamingStatisticsVectorImageFilter< InputImageTypeCovarianceEstimatorFilterType
 
typedef TInputImage InputImageType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::NumericTraits< typename RealVectorType::ValueType >::RealType RealType
 
typedef itk::NumericTraits< typename TInputImage::PixelType >::RealType RealVectorType
 
typedef NormalizeVectorImageFilter Self
 
typedef UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, Functor::NormalizeVectorImageFunctor< typename TInputImage::PixelType, typename TOutputImage::PixelType > > Superclass
 
- Public Types inherited from otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, Functor::NormalizeVectorImageFunctor< TInputImage::PixelType, TOutputImage::PixelType > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef UnaryFunctorVectorImageFilter Self
 
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage > Superclass
 
typedef Functor::NormalizeVectorImageFunctor< TInputImage::PixelType, TOutputImage::PixelType > FunctorType
 
typedef TInputImage InputImageType
 
typedef InputImageType::ConstPointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef itk::ProcessObject ProcessObjectType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual CovarianceEstimatorFilterTypeGetCovarianceEstimator () const
 
virtual const char * GetNameOfClass () const
 
template<class T >
void SetMean (const itk::VariableLengthVector< T > &m)
 
template<class T >
void SetStdDev (const itk::VariableLengthVector< T > &sigma)
 
virtual void SetUseMean (bool _arg)
 
virtual void SetUseStdDev (bool _arg)
 
template<class T >
void SetVariance (const itk::VariableLengthVector< T > &var)
 
- Public Member Functions inherited from otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, Functor::NormalizeVectorImageFunctor< TInputImage::PixelType, TOutputImage::PixelType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
FunctorTypeGetFunctor ()
 
void SetFunctor (const FunctorType &functor)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, Functor::NormalizeVectorImageFunctor< TInputImage::PixelType, TOutputImage::PixelType > >
static Pointer New ()
 

Protected Member Functions

void GenerateOutputInformation () override
 
 NormalizeVectorImageFilter ()
 
 ~NormalizeVectorImageFilter () override
 
- Protected Member Functions inherited from otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, Functor::NormalizeVectorImageFunctor< TInputImage::PixelType, TOutputImage::PixelType > >
 UnaryFunctorVectorImageFilter ()
 
 ~UnaryFunctorVectorImageFilter () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void GenerateOutputInformation (void) override
 

Private Member Functions

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

Private Attributes

CovarianceEstimatorFilterPointerType m_CovarianceEstimator
 
bool m_IsGivenMean
 
bool m_IsGivenStdDev
 
bool m_UseMean
 
bool m_UseStdDev
 

Additional Inherited Members

- Static Public Attributes inherited from otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, Functor::NormalizeVectorImageFunctor< TInputImage::PixelType, TOutputImage::PixelType > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 

Detailed Description

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

Normalize an VectorImage by setting its mean to zero and possibly variance to one (band by band).

NormalizeVectorImageFilter shifts and scales an image so that the pixels in the image have a zero mean and unit variance.

This filter uses StreamingStatisticsVectorImageFilter to compute the mean and variance of the input and then applies the dedicated functor.

See also
StreamingStatisticsVectorImageFilter

Definition at line 132 of file otbNormalizeVectorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 143 of file otbNormalizeVectorImageFilter.h.

◆ CovarianceEstimatorFilterPointerType

template<class TInputImage , class TOutputImage >
typedef CovarianceEstimatorFilterType::Pointer otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::CovarianceEstimatorFilterPointerType

Definition at line 158 of file otbNormalizeVectorImageFilter.h.

◆ CovarianceEstimatorFilterType

template<class TInputImage , class TOutputImage >
typedef StreamingStatisticsVectorImageFilter<InputImageType> otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::CovarianceEstimatorFilterType

Definition at line 157 of file otbNormalizeVectorImageFilter.h.

◆ InputImageType

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

Definition at line 149 of file otbNormalizeVectorImageFilter.h.

◆ OutputImageType

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

Definition at line 152 of file otbNormalizeVectorImageFilter.h.

◆ Pointer

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

Definition at line 142 of file otbNormalizeVectorImageFilter.h.

◆ RealType

template<class TInputImage , class TOutputImage >
typedef itk::NumericTraits<typename RealVectorType::ValueType>::RealType otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::RealType

Definition at line 155 of file otbNormalizeVectorImageFilter.h.

◆ RealVectorType

template<class TInputImage , class TOutputImage >
typedef itk::NumericTraits<typename TInputImage::PixelType>::RealType otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::RealVectorType

Definition at line 154 of file otbNormalizeVectorImageFilter.h.

◆ Self

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

Standard class typedefs

Definition at line 138 of file otbNormalizeVectorImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
typedef UnaryFunctorVectorImageFilter<TInputImage, TOutputImage, Functor::NormalizeVectorImageFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType> > otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 141 of file otbNormalizeVectorImageFilter.h.

Constructor & Destructor Documentation

◆ NormalizeVectorImageFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::NormalizeVectorImageFilter
protected

Definition at line 29 of file otbNormalizeVectorImageFilter.hxx.

◆ ~NormalizeVectorImageFilter()

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

Definition at line 195 of file otbNormalizeVectorImageFilter.h.

◆ NormalizeVectorImageFilter() [2/2]

template<class TInputImage , class TOutputImage >
otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::NormalizeVectorImageFilter ( const Self )
private

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >
void otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation
overrideprotected

Definition at line 42 of file otbNormalizeVectorImageFilter.hxx.

◆ GetCovarianceEstimator()

template<class TInputImage , class TOutputImage >
virtual CovarianceEstimatorFilterType* otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::GetCovarianceEstimator ( ) const
virtual

◆ GetNameOfClass()

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

Creation through object factory macro

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

◆ SetMean()

template<class TInputImage , class TOutputImage >
template<class T >
void otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::SetMean ( const itk::VariableLengthVector< T > &  m)
inline

Definition at line 163 of file otbNormalizeVectorImageFilter.h.

◆ SetStdDev()

template<class TInputImage , class TOutputImage >
template<class T >
void otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::SetStdDev ( const itk::VariableLengthVector< T > &  sigma)
inline

Definition at line 172 of file otbNormalizeVectorImageFilter.h.

◆ SetUseMean()

template<class TInputImage , class TOutputImage >
virtual void otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::SetUseMean ( bool  _arg)
virtual

◆ SetUseStdDev()

template<class TInputImage , class TOutputImage >
virtual void otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::SetUseStdDev ( bool  _arg)
virtual

◆ SetVariance()

template<class TInputImage , class TOutputImage >
template<class T >
void otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::SetVariance ( const itk::VariableLengthVector< T > &  var)
inline

Definition at line 181 of file otbNormalizeVectorImageFilter.h.

Member Data Documentation

◆ m_CovarianceEstimator

template<class TInputImage , class TOutputImage >
CovarianceEstimatorFilterPointerType otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::m_CovarianceEstimator
private

Definition at line 212 of file otbNormalizeVectorImageFilter.h.

◆ m_IsGivenMean

template<class TInputImage , class TOutputImage >
bool otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::m_IsGivenMean
private

Definition at line 206 of file otbNormalizeVectorImageFilter.h.

◆ m_IsGivenStdDev

template<class TInputImage , class TOutputImage >
bool otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::m_IsGivenStdDev
private

Definition at line 207 of file otbNormalizeVectorImageFilter.h.

◆ m_UseMean

template<class TInputImage , class TOutputImage >
bool otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::m_UseMean
private

Definition at line 209 of file otbNormalizeVectorImageFilter.h.

◆ m_UseStdDev

template<class TInputImage , class TOutputImage >
bool otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >::m_UseStdDev
private

Definition at line 210 of file otbNormalizeVectorImageFilter.h.


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