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

This functor computes the Angular Vegetation Index (AVI) More...

#include <otbVegetationIndicesFunctor.h>

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

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 

Public Member Functions

 AVI ()
 
virtual ~AVI ()
 
unsigned int GetGreenIndex () const
 Get Green Index. More...
 
unsigned int GetIndex (BandName::BandName band) const
 
double GetLambdaG (void) const
 
double GetLambdaNir (void) const
 
double GetLambdaR (void) 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 RAndGAndNIRIndexBase &) const
 
TOutput operator() (const InputVectorType &inputVector)
 
TOutput operator() (const TInput1 &r, const TInput2 &g, const TInput2 &nir)
 
bool operator== (const RAndGAndNIRIndexBase &other) const
 
void SetGreenIndex (unsigned int channel)
 Set Green Index. More...
 
void SetIndex (BandName::BandName band, unsigned int channel)
 
void SetLambdaG (const double lg)
 
void SetLambdaNir (const double lnir)
 
void SetLambdaR (const double lr)
 
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 &g, const TInput3 &nir) const
 

Protected Attributes

double m_EpsilonToBeConsideredAsZero
 

Private Attributes

double m_LambdaG
 
double m_LambdaNir
 
double m_LambdaR
 

Detailed Description

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

This functor computes the Angular Vegetation Index (AVI)

This vegetation index use three inputs channels

[Plummer & al., 1994]

Definition at line 864 of file otbVegetationIndicesFunctor.h.

Member Typedef Documentation

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

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

Definition at line 281 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

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

Definition at line 873 of file otbVegetationIndicesFunctor.h.

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

Definition at line 874 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::Evaluate ( const TInput1 &  r,
const TInput2 &  g,
const TInput3 &  nir 
) const
inlineprotectedvirtual
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetGreenIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex ( BandName::BandName  band) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::GetLambdaG ( void  ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::GetLambdaNir ( void  ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::GetLambdaR ( void  ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual std::string otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::GetName ( ) const
inlinevirtual
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetNIRIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetRedIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator!= ( const RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput > &  ) const
inlineinherited

Definition at line 284 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const InputVectorType inputVector)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const TInput1 &  r,
const TInput2 &  g,
const TInput2 &  nir 
)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator== ( const RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput > &  other) const
inlineinherited

Definition at line 289 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetGreenIndex ( unsigned int  channel)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::SetLambdaG ( const double  lg)
inline

Set/Get Lambda green parameter

Definition at line 885 of file otbVegetationIndicesFunctor.h.

References otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::m_LambdaG.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::SetLambdaNir ( const double  lnir)
inline

Set/Get Lambda red parameter

Definition at line 894 of file otbVegetationIndicesFunctor.h.

References otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::m_LambdaNir.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::SetLambdaR ( const double  lr)
inline

Set/Get Lambda red parameter

Definition at line 876 of file otbVegetationIndicesFunctor.h.

References otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::m_LambdaR.

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

Member Data Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::RAndGAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_EpsilonToBeConsideredAsZero
protectedinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::m_LambdaG
private
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::m_LambdaNir
private
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::AVI< TInput1, TInput2, TInput3, TOutput >::m_LambdaR
private

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

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