otb::Functor::NDVI< TInput1, TInput2, TOutput > Class Template Reference

This functor computes the Normalized Difference Vegetation Index (NDVI) More...

#include <otbVegetationIndicesFunctor.h>

Inheritance diagram for otb::Functor::NDVI< TInput1, TInput2, TOutput >:

Collaboration diagram for otb::Functor::NDVI< TInput1, TInput2, TOutput >:

List of all members.

Public Types
typedef itk::VariableLengthVector < TInput1 >	InputVectorType

Public Member Functions
	NDVI ()
	Constructor.
virtual	~NDVI ()
	Desctructor.
unsigned int	GetIndex (BandName::BandName band) const
virtual std::string	GetName () const
unsigned int	GetNIRIndex () const
	Get NIR Index.
unsigned int	GetRedIndex () const
	Get Red Index.
bool	operator!= (const RAndNIRIndexBase &) const
TOutput	operator() (const InputVectorType &inputVector) const
TOutput	operator() (const TInput1 &r, const TInput2 &nir) const
bool	operator== (const RAndNIRIndexBase &other) const
void	SetIndex (BandName::BandName band, unsigned int channel)
void	SetNIRIndex (unsigned int channel)
	Set NIR Index.
void	SetRedIndex (unsigned int channel)
	Set Red Index.

Protected Member Functions
TOutput	Evaluate (const TInput1 &r, const TInput2 &nir) const

Protected Attributes
double	m_EpsilonToBeConsideredAsZero

---

Detailed Description

template<class TInput1, class TInput2, class TOutput>
class otb::Functor::NDVI< TInput1, TInput2, TOutput >

This functor computes the Normalized Difference Vegetation Index (NDVI)

[Rouse et al., 1973]

Definition at line 401 of file otbVegetationIndicesFunctor.h.

---

Member Typedef Documentation

template<class TInput1, class TInput2, class TOutput>

typedef itk::VariableLengthVector<TInput1> otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::InputVectorType

inherited

Vector pixel type used to support both vector images and multiple input images

Definition at line 49 of file otbVegetationIndicesFunctor.h.

---

Constructor & Destructor Documentation

template<class TInput1, class TInput2, class TOutput>

otb::Functor::NDVI< TInput1, TInput2, TOutput >::NDVI ( )

inline

Constructor.

Definition at line 412 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

virtual otb::Functor::NDVI< TInput1, TInput2, TOutput >::~NDVI ( )

inlinevirtual

Desctructor.

Definition at line 414 of file otbVegetationIndicesFunctor.h.

---

Member Function Documentation

template<class TInput1, class TInput2, class TOutput>

TOutput otb::Functor::NDVI< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  r, const TInput2 &  nir  ) const

inlineprotectedvirtual

Implements otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >.

Definition at line 417 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

unsigned int otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::GetIndex ( BandName::BandName  band ) const

inlineinherited

Get index, generic method

Definition at line 91 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

virtual std::string otb::Functor::NDVI< TInput1, TInput2, TOutput >::GetName ( ) const

inlinevirtual

Return the index name

Implements otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >.

Definition at line 406 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

unsigned int otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::GetNIRIndex ( ) const

inlineinherited

Get NIR Index.

Definition at line 119 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

unsigned int otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::GetRedIndex ( ) const

inlineinherited

Get Red Index.

Definition at line 109 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

bool otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::operator!= ( const RAndNIRIndexBase< TInput1, TInput2, TOutput > &  ) const

inlineinherited

Definition at line 52 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

TOutput otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::operator() ( const InputVectorType &  inputVector ) const

inlineinherited

Definition at line 63 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

TOutput otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::operator() ( const TInput1 &  r, const TInput2 &  nir  ) const

inlineinherited

Definition at line 69 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

bool otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::operator== ( const RAndNIRIndexBase< TInput1, TInput2, TOutput > &  other ) const

inlineinherited

Definition at line 57 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

void otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::SetIndex ( BandName::BandName  band, unsigned int  channel  )

inlineinherited

Set index, generic method

Definition at line 79 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

void otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::SetNIRIndex ( unsigned int  channel )

inlineinherited

Set NIR Index.

Definition at line 114 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::RadiometricNonWaterNonVegetationIndexFunctor< TInput >::SetNIRIndex().

template<class TInput1, class TInput2, class TOutput>

void otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::SetRedIndex ( unsigned int  channel )

inlineinherited

Set Red Index.

Definition at line 104 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::RadiometricNonWaterNonVegetationIndexFunctor< TInput >::SetRedIndex().

---

Member Data Documentation

template<class TInput1, class TInput2, class TOutput>

double otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::m_EpsilonToBeConsideredAsZero

protectedinherited

Definition at line 131 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::NDVI< double, double, double >::Evaluate(), otb::Functor::RVI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::SAVI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::TSAVI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::MSAVI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::GEMI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::IPVI< TInput1, TInput2, TOutput >::Evaluate(), and otb::Functor::LAIFromNDVIFormosat2Functor< TInput1, TInput2, TOutput >::Evaluate().

---

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

• otbVegetationIndicesFunctor.h