otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbNormalizeInnerProductPCAImageFilter.h>

Inheritance diagram for otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef NormalizeInnerProductPCAImageFilter	Self
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

Static Public Member Functions
static Pointer	New ()
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef InputImageType::PixelType	InputPixelType
typedef InputImageType::InternalPixelType	InputInternalPixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef OutputImageType::PixelType	OutputPixelType
typedef OutputImageType::InternalPixelType	OutputInternalPixelType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef InputImageType::SizeType	SizeType
typedef StreamingStatisticsVectorImageFilter< InputImageType >	StreamingStatisticsVectorImageFilterType
typedef StreamingStatisticsVectorImageFilterType::Pointer	StreamingStatisticsVectorImageFilterPointer
typedef StreamingStatisticsVectorImageFilterType::RealType	RealType
typedef StreamingStatisticsVectorImageFilterType::RealPixelType	RealPixelType
typedef StreamingStatisticsVectorImageFilterType::MatrixType	MatrixType
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
RealPixelType	m_CoefNorm
bool	m_UseUnbiasedEstimator
virtual void	SetUseUnbiasedEstimator (bool _arg)
virtual bool	GetUseUnbiasedEstimator ()
	NormalizeInnerProductPCAImageFilter ()
	~NormalizeInnerProductPCAImageFilter () override
void	GenerateOutputInformation () override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
void	BeforeThreadedGenerateData () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Detailed Description

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

The aim of the class is to normalise vector images using a vector coefficient values.

Definition at line 38 of file otbNormalizeInnerProductPCAImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<const Self> otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 46 of file otbNormalizeInnerProductPCAImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::InputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 66 of file otbNormalizeInnerProductPCAImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage >

typedef TInputImage otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::InputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 60 of file otbNormalizeInnerProductPCAImageFilter.h.

InputInternalPixelType

template<class TInputImage , class TOutputImage >

typedef InputImageType::InternalPixelType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 65 of file otbNormalizeInnerProductPCAImageFilter.h.

InputPixelType

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::InputPixelType

Supported images definition.

Definition at line 64 of file otbNormalizeInnerProductPCAImageFilter.h.

MatrixType

template<class TInputImage , class TOutputImage >

typedef StreamingStatisticsVectorImageFilterType::MatrixType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::MatrixType

"typedef" to simplify the variables definition and the declaration.

Definition at line 79 of file otbNormalizeInnerProductPCAImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 69 of file otbNormalizeInnerProductPCAImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage >

typedef TOutputImage otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::OutputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 61 of file otbNormalizeInnerProductPCAImageFilter.h.

OutputInternalPixelType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::InternalPixelType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 68 of file otbNormalizeInnerProductPCAImageFilter.h.

OutputPixelType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::OutputPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 67 of file otbNormalizeInnerProductPCAImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<Self> otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 45 of file otbNormalizeInnerProductPCAImageFilter.h.

RealPixelType

template<class TInputImage , class TOutputImage >

typedef StreamingStatisticsVectorImageFilterType::RealPixelType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::RealPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 78 of file otbNormalizeInnerProductPCAImageFilter.h.

RealType

template<class TInputImage , class TOutputImage >

typedef StreamingStatisticsVectorImageFilterType::RealType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::RealType

"typedef" to simplify the variables definition and the declaration.

Definition at line 77 of file otbNormalizeInnerProductPCAImageFilter.h.

Self

template<class TInputImage , class TOutputImage >

typedef NormalizeInnerProductPCAImageFilter otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 43 of file otbNormalizeInnerProductPCAImageFilter.h.

SizeType

template<class TInputImage , class TOutputImage >

typedef InputImageType::SizeType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::SizeType

Image size "typedef" definition.

Definition at line 72 of file otbNormalizeInnerProductPCAImageFilter.h.

StreamingStatisticsVectorImageFilterPointer

template<class TInputImage , class TOutputImage >

typedef StreamingStatisticsVectorImageFilterType::Pointer otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::StreamingStatisticsVectorImageFilterPointer

"typedef" to simplify the variables definition and the declaration.

Definition at line 76 of file otbNormalizeInnerProductPCAImageFilter.h.

StreamingStatisticsVectorImageFilterType

template<class TInputImage , class TOutputImage >

typedef StreamingStatisticsVectorImageFilter<InputImageType> otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::StreamingStatisticsVectorImageFilterType

Typedef for statistic computing.

Definition at line 75 of file otbNormalizeInnerProductPCAImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage >

typedef itk::InPlaceImageFilter<TInputImage, TOutputImage> otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 44 of file otbNormalizeInnerProductPCAImageFilter.h.

Constructor & Destructor Documentation

NormalizeInnerProductPCAImageFilter()

template<class TInputImage , class TOutputImage >

otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::NormalizeInnerProductPCAImageFilter

protected

Constructor

Definition at line 36 of file otbNormalizeInnerProductPCAImageFilter.hxx.

~NormalizeInnerProductPCAImageFilter()

template<class TInputImage , class TOutputImage >

otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::~NormalizeInnerProductPCAImageFilter ( )

inlineoverrideprotected

"typedef" to simplify the variables definition and the declaration.

Definition at line 86 of file otbNormalizeInnerProductPCAImageFilter.h.

Member Function Documentation

BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData

overrideprotected

BeforeThreadedGenerateData method

BeforeThreadedGenerateData Performs the pixel-wise addition

Definition at line 59 of file otbNormalizeInnerProductPCAImageFilter.hxx.

CreateAnother()

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

const

GenerateOutputInformation()

template<class TInputImage , class TOutputImage >

void otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation

overrideprotected

NormalizeInnerProductPCAImageFilter can produce an image which is a different resolution than its input image. As such, NormalizeInnerProductPCAImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also

ProcessObject::GenerateOutputInformation()

GenerateOutputInformation

Definition at line 50 of file otbNormalizeInnerProductPCAImageFilter.hxx.

GetNameOfClass()

template<class TInputImage , class TOutputImage >

virtual const char* otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

return class name.

GetUseUnbiasedEstimator()

template<class TInputImage , class TOutputImage >

virtual bool otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::GetUseUnbiasedEstimator ( )

virtual

"typedef" to simplify the variables definition and the declaration.

New()

template<class TInputImage , class TOutputImage >

static Pointer otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<class TInputImage , class TOutputImage >

void otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

"typedef" to simplify the variables definition and the declaration.

Definition at line 126 of file otbNormalizeInnerProductPCAImageFilter.hxx.

SetUseUnbiasedEstimator()

template<class TInputImage , class TOutputImage >

virtual void otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::SetUseUnbiasedEstimator ( bool  _arg )

virtual

"typedef" to simplify the variables definition and the declaration.

ThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, itk::ThreadIdType  threadId  )

overrideprotected

NormalizeInnerProductPCAImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also

ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

ThreadedGenerateData Performs the pixel-wise addition

Definition at line 86 of file otbNormalizeInnerProductPCAImageFilter.hxx.

Member Data Documentation

InputImageDimension

template<class TInputImage , class TOutputImage >

const unsigned int otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

static

Extract input and output images dimensions.

Definition at line 55 of file otbNormalizeInnerProductPCAImageFilter.h.

m_CoefNorm

template<class TInputImage , class TOutputImage >

RealPixelType otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::m_CoefNorm

private

Contains normalization coefficient input image

Definition at line 119 of file otbNormalizeInnerProductPCAImageFilter.h.

m_UseUnbiasedEstimator

template<class TInputImage , class TOutputImage >

bool otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::m_UseUnbiasedEstimator

private

"typedef" to simplify the variables definition and the declaration.

Definition at line 122 of file otbNormalizeInnerProductPCAImageFilter.h.

OutputImageDimension

template<class TInputImage , class TOutputImage >

const unsigned int otb::NormalizeInnerProductPCAImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

"typedef" to simplify the variables definition and the declaration.

Definition at line 56 of file otbNormalizeInnerProductPCAImageFilter.h.

---

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

• otbNormalizeInnerProductPCAImageFilter.h
• otbNormalizeInnerProductPCAImageFilter.hxx