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

This functor computes the Atmospherically Resistant Vegetation Index (ARVI) More...

#include <otbVegetationIndicesFunctor.h>

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

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 		InputVectorType
 

Public Member Functions

 ARVI ()
 
virtual ~ARVI ()
 
unsigned int GetBlueIndex () const
 Get Blue Index. More...
 
double GetGamma (void) const
 
unsigned int GetIndex (BandName::BandName band) const
 
virtual std::string GetName () const
 
unsigned int GetNIRIndex () const
 Get NIR Index. More...
 
unsigned int GetRedIndex () const
 Get Red Index. More...
 
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. More...
 
void SetGamma (const double gamma)
 
void SetIndex (BandName::BandName band, unsigned int channel)
 
void SetNIRIndex (unsigned int channel)
 Set NIR Index. More...
 
void SetRedIndex (unsigned int channel)
 Set Red Index. More...
 

Protected Member Functions

TOutput Evaluate (const TInput1 &r, const TInput2 &b, const TInput3 &nir) const
 

Protected Attributes

double m_EpsilonToBeConsideredAsZero
 

Private Attributes

double m_Gamma
 

Detailed Description

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

This functor computes the Atmospherically Resistant Vegetation Index (ARVI)

This vegetation index use three inputs channels

[Yoram J. Kaufman and Didier Tanre, 1992]

Definition at line 957 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::ARVI< TInput1, TInput2, TInput3, TOutput >::ARVI ( )
inline

Definition at line 966 of file otbVegetationIndicesFunctor.h.

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

Definition at line 967 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::ARVI< 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 980 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_EpsilonToBeConsideredAsZero, and otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >::m_Gamma.

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::ARVI< TInput1, TInput2, TInput3, TOutput >::GetGamma ( void  ) const
inline

Definition at line 974 of file otbVegetationIndicesFunctor.h.

References otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >::m_Gamma.

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 >
virtual std::string otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >::GetName ( ) const
inlinevirtual

Return the index name

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

Definition at line 961 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::ARVI< TInput1, TInput2, TInput3, TOutput >::SetGamma ( const double  gamma)
inline

Set/Get Gamma parameter

Definition at line 970 of file otbVegetationIndicesFunctor.h.

References otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >::m_Gamma.

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::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::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::ARVI< TInput1, TInput2, TInput3, TOutput >::m_Gamma
private

Gamma parameter

Definition at line 997 of file otbVegetationIndicesFunctor.h.

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

The documentation for this class was generated from the following file:
Generated at Sun May 19 2013 04:29:05 for Orfeo Toolbox with doxygen 1.8.3.1