otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel > Class Template Reference

This functor uses a spectral angle with a particular reference pixel. More...

#include <otbWaterIndicesFunctor.h>

Inheritance diagram for otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >:

Collaboration diagram for otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >:

Public Types
typedef TInputVectorPixel	InputVectorPixelType
typedef WaterSqrtSpectralAngleFunctor	Self
typedef SqrtSpectralAngleFunctor < TInputVectorPixel, TOutputPixel >	Superclass

Public Member Functions
	WaterSqrtSpectralAngleFunctor ()
virtual	~WaterSqrtSpectralAngleFunctor ()
unsigned int	GetBlueChannel () const
unsigned int	GetGreenChannel () const
unsigned int	GetIndex (BandName::BandName band) const
virtual std::string	GetName () const
unsigned int	GetNIRChannel () const
unsigned int	GetRedChannel () const
TInputVectorPixel	GetReferencePixel () const
TOutputPixel	operator() (const TInputVectorPixel &inPix) const
void	SetBlueChannel (unsigned int channel)
void	SetGreenChannel (unsigned int channel)
void	SetIndex (BandName::BandName band, unsigned int channel)
void	SetNIRChannel (unsigned int channel)
void	SetRedChannel (unsigned int channel)
void	SetReferencePixel (TInputVectorPixelref)
void	SetReferenceWaterPixel (InputVectorPixelType ref)

Protected Member Functions
TOutputPixel	Evaluate (const TInputVectorPixel &inPix) const

Protected Attributes
int	m_BlueIndex
int	m_GreenIndex
int	m_NIRIndex
int	m_RedIndex
TInputVectorPixel	m_ReferencePixel
double	m_RefNorm

Detailed Description

template<class TInputVectorPixel, class TOutputPixel>
class otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >

This functor uses a spectral angle with a particular reference pixel.

Definition at line 606 of file otbWaterIndicesFunctor.h.

Member Typedef Documentation

template<class TInputVectorPixel , class TOutputPixel >

typedef TInputVectorPixel otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::InputVectorPixelType

Definition at line 616 of file otbWaterIndicesFunctor.h.

template<class TInputVectorPixel , class TOutputPixel >

typedef WaterSqrtSpectralAngleFunctor otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::Self

Definition at line 614 of file otbWaterIndicesFunctor.h.

template<class TInputVectorPixel , class TOutputPixel >

typedef SqrtSpectralAngleFunctor<TInputVectorPixel, TOutputPixel> otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::Superclass

Definition at line 615 of file otbWaterIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInputVectorPixel , class TOutputPixel >

otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::WaterSqrtSpectralAngleFunctor ( )

inline

Definition at line 617 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_BlueIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_GreenIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_NIRIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_RedIndex, and otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferenceWaterPixel().

template<class TInputVectorPixel , class TOutputPixel >

virtual otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::~WaterSqrtSpectralAngleFunctor ( )

inlinevirtual

Definition at line 632 of file otbWaterIndicesFunctor.h.

Member Function Documentation

template<class TInputVectorPixel , class TOutputPixel >

TOutputPixel otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::Evaluate ( const TInputVectorPixel &  inPix ) const

inlineprotectedvirtual

Reimplemented from otb::Functor::SqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >.

Definition at line 724 of file otbWaterIndicesFunctor.h.

References otb::Functor::SqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::Evaluate().

template<class TInputVectorPixel , class TOutputPixel >

unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetBlueChannel ( ) const

inline

Definition at line 653 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_BlueIndex.

template<class TInputVectorPixel , class TOutputPixel >

unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetGreenChannel ( ) const

inline

Definition at line 661 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_GreenIndex.

template<class TInputVectorPixel , class TOutputPixel >

unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetIndex ( BandName::BandName  band ) const

inline

Get index, generic method

Definition at line 703 of file otbWaterIndicesFunctor.h.

References otb::BandName::BLUE, otb::BandName::GREEN, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_BlueIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_GreenIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_NIRIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_RedIndex, otb::BandName::NIR, and otb::BandName::RED.

template<class TInputVectorPixel , class TOutputPixel >

virtual std::string otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetName ( ) const

inlinevirtual

Return the index name

Definition at line 610 of file otbWaterIndicesFunctor.h.

template<class TInputVectorPixel , class TOutputPixel >

unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetNIRChannel ( ) const

inline

Definition at line 677 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_NIRIndex.

template<class TInputVectorPixel , class TOutputPixel >

unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetRedChannel ( ) const

inline

Definition at line 669 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_RedIndex.

TInputVectorPixel otb::Functor::SpectralAngleFunctor< TInputVectorPixel , TOutputPixel >::GetReferencePixel ( ) const

inlineinherited

Definition at line 58 of file otbSpectralAngleFunctor.h.

References otb::Functor::SpectralAngleFunctor< TInput, TOutputValue >::m_ReferencePixel.

TOutputPixel otb::Functor::SpectralAngleFunctor< TInputVectorPixel , TOutputPixel >::operator() ( const TInputVectorPixel &  inPix ) const

inlineinherited

Definition at line 43 of file otbSpectralAngleFunctor.h.

References otb::Functor::SpectralAngleFunctor< TInput, TOutputValue >::Evaluate().

template<class TInputVectorPixel , class TOutputPixel >

void otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetBlueChannel ( unsigned int  channel )

inline

Getters and setters

Definition at line 649 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_BlueIndex.

template<class TInputVectorPixel , class TOutputPixel >

void otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetGreenChannel ( unsigned int  channel )

inline

Definition at line 657 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_GreenIndex.

template<class TInputVectorPixel , class TOutputPixel >

void otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetIndex ( BandName::BandName  band, unsigned int  channel  )

inline

Set index, generic method

Definition at line 683 of file otbWaterIndicesFunctor.h.

References otb::BandName::BLUE, otb::BandName::GREEN, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_BlueIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_GreenIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_NIRIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_RedIndex, otb::BandName::NIR, and otb::BandName::RED.

template<class TInputVectorPixel , class TOutputPixel >

void otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetNIRChannel ( unsigned int  channel )

inline

Definition at line 673 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_NIRIndex.

template<class TInputVectorPixel , class TOutputPixel >

void otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetRedChannel ( unsigned int  channel )

inline

Definition at line 665 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_RedIndex.

void otb::Functor::SpectralAngleFunctor< TInputVectorPixel , TOutputPixel >::SetReferencePixel ( TInputVectorPixel  ref )

inlineinherited

Definition at line 48 of file otbSpectralAngleFunctor.h.

References otb::Functor::SpectralAngleFunctor< TInput, TOutputValue >::m_ReferencePixel, and otb::Functor::SpectralAngleFunctor< TInput, TOutputValue >::m_RefNorm.

Referenced by otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferenceWaterPixel().

template<class TInputVectorPixel , class TOutputPixel >

void otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferenceWaterPixel ( InputVectorPixelType  ref )

inline

Set Reference Pixel

Definition at line 635 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_BlueIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_GreenIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_NIRIndex, otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_RedIndex, and otb::Functor::SpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferencePixel().

Referenced by otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::WaterSqrtSpectralAngleFunctor().

Member Data Documentation

template<class TInputVectorPixel , class TOutputPixel >

int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_BlueIndex

protected

Channels

Definition at line 730 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetBlueChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetBlueChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferenceWaterPixel(), and otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::WaterSqrtSpectralAngleFunctor().

template<class TInputVectorPixel , class TOutputPixel >

int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_GreenIndex

protected

Definition at line 731 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetGreenChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetGreenChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferenceWaterPixel(), and otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::WaterSqrtSpectralAngleFunctor().

template<class TInputVectorPixel , class TOutputPixel >

int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_NIRIndex

protected

Definition at line 733 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetNIRChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetNIRChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferenceWaterPixel(), and otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::WaterSqrtSpectralAngleFunctor().

template<class TInputVectorPixel , class TOutputPixel >

int otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::m_RedIndex

protected

Definition at line 732 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::GetRedChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetIndex(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetRedChannel(), otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::SetReferenceWaterPixel(), and otb::Functor::WaterSqrtSpectralAngleFunctor< TInputVectorPixel, TOutputPixel >::WaterSqrtSpectralAngleFunctor().

TInputVectorPixel otb::Functor::SpectralAngleFunctor< TInputVectorPixel , TOutputPixel >::m_ReferencePixel

protectedinherited

Definition at line 95 of file otbSpectralAngleFunctor.h.

double otb::Functor::SpectralAngleFunctor< TInputVectorPixel , TOutputPixel >::m_RefNorm

protectedinherited

Definition at line 96 of file otbSpectralAngleFunctor.h.

---

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

• otbWaterIndicesFunctor.h