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

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 >:

List of all members.

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 		InputVectorType

Public Member Functions

 SAVI ()
virtual ~SAVI ()
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 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 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 &nir) const

Protected Attributes

double m_EpsilonToBeConsideredAsZero

Private Attributes

double m_L

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.

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::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

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

Definition at line 557 of file otbVegetationIndicesFunctor.h.

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

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 >
double otb::Functor::SAVI< TInput1, TInput2, TOutput >::GetL ( void  ) const
inline

Definition at line 551 of file otbVegetationIndicesFunctor.h.

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

template<class TInput1 , class TInput2 , class TOutput >
virtual std::string otb::Functor::SAVI< TInput1, TInput2, TOutput >::GetName ( ) 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>
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::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.

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().

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

L correction

Definition at line 572 of file otbVegetationIndicesFunctor.h.

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

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