Orfeo Toolbox  3.16
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput > Class Template Reference
Radiometry modules

This functor computes the Enhanced Vegetation Index (EVI) More...

#include <otbVegetationIndicesFunctor.h>

+ Inheritance diagram for otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >:
+ Collaboration diagram for otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >:

List of all members.

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 		InputVectorType

Public Member Functions

 EVI ()
virtual ~EVI ()
unsigned int GetBlueIndex () const
 Get Blue Index.
double GetC1 (void) const
double GetC2 (void) const
double GetG (void) const
unsigned int GetIndex (BandName::BandName band) const
double GetL (void) const
virtual std::string GetName () const
unsigned int GetNIRIndex () const
 Get NIR Index.
unsigned int GetRedIndex () const
 Get Red Index.
bool operator!= (const RAndBAndNIRIndexBase &) const
TOutput operator() (const InputVectorType &inputVector)
TOutput operator() (const TInput1 &r, const TInput2 &b, const TInput2 &nir)
bool operator== (const RAndBAndNIRIndexBase &other) const
void SetBlueIndex (unsigned int channel)
 Set Blue Index.
void SetC1 (const double c1)
void SetC2 (const double c2)
void SetG (const double g)
void SetIndex (BandName::BandName band, unsigned int channel)
void SetL (const double l)
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 &b, const TInput3 &nir) const

Protected Attributes

double m_EpsilonToBeConsideredAsZero

Private Attributes

double m_C1
double m_C2
double m_G
double m_L

Detailed Description

template<class TInput1, class TInput2, class TInput3, class TOutput>
class otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >

This functor computes the Enhanced Vegetation Index (EVI)

This vegetation index use three inputs channels

[Huete, Justice, & Liu, 1994; Huete, Liu, Batchily, & van Leeuwen, 1997]

Definition at line 1095 of file otbVegetationIndicesFunctor.h.

Member Typedef Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
typedef itk::VariableLengthVector<TInput1> otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::InputVectorType
inherited

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

Definition at line 154 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::EVI ( )
inline

Definition at line 1104 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::~EVI ( )
inlinevirtual

Definition at line 1105 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::Evaluate ( const TInput1 &  r,
const TInput2 &  b,
const TInput3 &  nir 
) const
inlineprotectedvirtual

Implements otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >.

Definition at line 1143 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C1, otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C2, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_EpsilonToBeConsideredAsZero, otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_G, and otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_L.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetBlueIndex ( ) const
inlineinherited

Get Blue Index.

Definition at line 234 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetC1 ( void  ) const
inline

Definition at line 1120 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C1.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetC2 ( void  ) const
inline

Definition at line 1129 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C2.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetG ( void  ) const
inline

Definition at line 1111 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_G.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex ( BandName::BandName  band) const
inlineinherited

Get index, generic method

Definition at line 202 of file otbVegetationIndicesFunctor.h.

References otb::BandName::BLUE, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex, otb::BandName::NIR, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetL ( void  ) const
inline

Definition at line 1138 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_L.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual std::string otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetName ( ) const
inlinevirtual

Return the index name

Implements otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >.

Definition at line 1099 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetNIRIndex ( ) const
inlineinherited

Get NIR Index.

Definition at line 245 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetRedIndex ( ) const
inlineinherited

Get Red Index.

Definition at line 224 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator!= ( const RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput > &  ) const
inlineinherited

Definition at line 157 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const InputVectorType &  inputVector)
inlineinherited

Definition at line 169 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex, and otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const TInput1 &  r,
const TInput2 &  b,
const TInput2 &  nir 
)
inlineinherited

Definition at line 176 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::Evaluate().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator== ( const RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput > &  other) const
inlineinherited

Definition at line 163 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetBlueIndex ( unsigned int  channel)
inlineinherited

Set Blue Index.

Definition at line 229 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetC1 ( const double  c1)
inline

Set/Get C1 parameter

Definition at line 1116 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C1.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetC2 ( const double  c2)
inline

Set/Get C2 parameter

Definition at line 1125 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C2.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetG ( const double  g)
inline

Set/Get G parameter

Definition at line 1107 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_G.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inlineinherited

Set index, generic method

Definition at line 186 of file otbVegetationIndicesFunctor.h.

References otb::BandName::BLUE, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex, otb::BandName::NIR, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetL ( const double  l)
inline

Set/Get L parameter

Definition at line 1134 of file otbVegetationIndicesFunctor.h.

References otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_L.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetNIRIndex ( unsigned int  channel)
inlineinherited

Set NIR Index.

Definition at line 240 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetRedIndex ( unsigned int  channel)
inlineinherited

Set Red Index.

Definition at line 219 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex.

Member Data Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C1
private

Coefficient of the aerosol resistance term

Definition at line 1162 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetC1(), and otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetC1().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_C2
private

Coefficient of the aerosol resistance term

Definition at line 1165 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetC2(), and otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetC2().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_EpsilonToBeConsideredAsZero
protectedinherited

Definition at line 257 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), and otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::Evaluate().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_G
private

Gain factor

Definition at line 1159 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetG(), and otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetG().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::m_L
private

Canopy background adjustment

Definition at line 1168 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::GetL(), and otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::SetL().

The documentation for this class was generated from the following file:
Generated at Sun Feb 3 2013 04:26:29 for Orfeo Toolbox with doxygen 1.8.1.1