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

This functor computes the Transformed Soil Atmospherical Resistant Vegetation Index (TSARVI) More...

#include <otbVegetationIndicesFunctor.h>

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

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 

Public Member Functions

 TSARVI ()
 
virtual ~TSARVI ()
 
double GetA (void) const
 
double GetB (void) const
 
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...
 
double GetX (void) const
 
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 SetA (const double A)
 
void SetB (const double B)
 
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...
 
void SetX (const double X)
 

Protected Member Functions

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

Protected Attributes

double m_EpsilonToBeConsideredAsZero
 

Private Attributes

double m_A
 
double m_B
 
double m_Gamma
 
double m_X
 

Detailed Description

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

This functor computes the Transformed Soil Atmospherical Resistant Vegetation Index (TSARVI)

[Yoram J. Kaufman and Didier Tanre, 1992]

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

Definition at line 1018 of file otbVegetationIndicesFunctor.h.

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

Definition at line 1019 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::Evaluate ( const TInput1 &  r,
const TInput2 &  b,
const TInput3 &  nir 
) const
inlineprotectedvirtual
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::GetA ( void  ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::GetB ( void  ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetBlueIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::GetGamma ( void  ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex ( BandName::BandName  band) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual std::string otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::GetName ( ) const
inlinevirtual
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetNIRIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetRedIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::GetX ( void  ) const
inline
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
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
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::TSARVI< TInput1, TInput2, TInput3, TOutput >::SetA ( const double  A)
inline

Set/Get A and B parameters

Definition at line 1022 of file otbVegetationIndicesFunctor.h.

References otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::m_A.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::SetB ( const double  B)
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetBlueIndex ( unsigned int  channel)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::SetGamma ( const double  gamma)
inline

Set/Get the gamma parameter

Definition at line 1048 of file otbVegetationIndicesFunctor.h.

References otb::Functor::TSARVI< 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
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetNIRIndex ( unsigned int  channel)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetRedIndex ( unsigned int  channel)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::SetX ( const double  X)
inline

Set/Get X parameter

Definition at line 1039 of file otbVegetationIndicesFunctor.h.

References otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::m_X.

Member Data Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::m_A
private
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::m_B
private
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_EpsilonToBeConsideredAsZero
protectedinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::m_Gamma
private
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::m_X
private

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

Generated at Sat Mar 8 2014 19:08:33 for Orfeo Toolbox with doxygen 1.8.3.1