Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::Functor::SAVI< TInput1, TInput2, TOutput > Class Template Reference

This functor computes the Soil Adjusted Vegetation Index (SAVI) More...

#include <otbVegetationIndicesFunctor.h>

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

Public Member Functions

 SAVI ()
 
virtual ~SAVI ()
 
double GetL (void) const
 
virtual std::string GetName () const
 
void SetL (const double L)
 
- Public Member Functions inherited from otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >
 RAndNIRIndexBase ()
 Constructor. More...
 
virtual ~RAndNIRIndexBase ()
 Desctructor. More...
 
unsigned int GetIndex (BandName::BandName band) const
 
unsigned int GetNIRIndex () const
 Get NIR Index. More...
 
unsigned int GetRedIndex () const
 Get Red Index. More...
 
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. More...
 
void SetRedIndex (unsigned int channel)
 Set Red Index. More...
 

Protected Member Functions

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

Private Attributes

double m_L
 

Additional Inherited Members

- Public Types inherited from otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >
typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 
- Protected Attributes inherited from otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >
double m_EpsilonToBeConsideredAsZero
 

Detailed Description

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

This functor computes the Soil Adjusted Vegetation Index (SAVI)

[Huete, 1988]

Definition at line 533 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

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

Definition at line 543 of file otbVegetationIndicesFunctor.h.

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

Definition at line 544 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >
TOutput otb::Functor::SAVI< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  r,
const TInput2 &  nir 
) const
inlineprotectedvirtual
template<class TInput1 , class TInput2 , class TOutput >
double otb::Functor::SAVI< TInput1, TInput2, TOutput >::GetL ( void  ) const
inline
template<class TInput1 , class TInput2 , class TOutput >
virtual std::string otb::Functor::SAVI< TInput1, TInput2, TOutput >::GetName ( void  ) const
inlinevirtual

Return the index name

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

Definition at line 538 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::SAVI< TInput1, TInput2, TOutput >::SetL ( const double  L)
inline

Set/Get L correction

Definition at line 547 of file otbVegetationIndicesFunctor.h.

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

Member Data Documentation

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

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