OTB  6.7.0
Orfeo Toolbox
Public Member Functions | Public Attributes | List of all members
otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput > Class Template Reference

#include <otbVegetationIndicesFunctor.h>

+ Inheritance diagram for otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >:
+ Collaboration diagram for otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >:

Public Member Functions

const double & GetExtionctionCoefficient () const
 
const double & GetNdviInf () const
 
const double & GetNdviSoil () const
 
 LAIFromNDVILogarithmic ()
 
 m_ExtinctionCoefficient (0.71)
 
 m_NdviInf (0.89)
 
 m_NdviSoil (0.1)
 
TOutput operator() (const itk::VariableLengthVector< TInput > &input) const override
 
void SetExtinctionCoefficient (const double &val)
 
void SetNdviInf (const double &val)
 
void SetNdviSoil (const double &val)
 
- Public Member Functions inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
 RadiometricIndex (const std::set< BandNameType > &requiredBands)
 
virtual ~RadiometricIndex ()=default
 
std::set< BandNameTypeGetRequiredBands () const
 
void SetBandIndex (BandNameType band, vcl_size_t index)
 
void SetBandsIndices (const std::map< BandNameType, vcl_size_t > &indicesMap)
 
vcl_size_t GetBandIndex (BandNameType band) const
 

Public Attributes

double m_ExtinctionCoefficient
 
double m_NdviInf
 
double m_NdviSoil
 

Additional Inherited Members

- Public Types inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
using BandNameType = CommonBandNames
 
using InputType = TInput
 
using OutputType = TOutput
 
using PixelType = itk::VariableLengthVector< InputType >
 
- Static Public Attributes inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
static constexpr double Epsilon = 0.0000001
 
static constexpr vcl_size_t NumberOfBands = static_cast<vcl_size_t>(BandNameType::MAX)
 
- Protected Member Functions inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
vcl_size_t UncheckedBandIndex (BandNameType band) const
 
double Value (BandNameType band, const itk::VariableLengthVector< TInput > &input) const
 

Detailed Description

template<class TInput, class TOutput>
class otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >

computes the LAI from NDVI

This functor computes the LAI from NDVI using a logarithmic relationship. Asrar et al. (1984), Baret and Guyot (1991) and Wilson and Meyers (2007). Default values for the parameters are taken from A. Bsaibes et al. / Remote Sensing of Environment 113 (2009) 716-729

Definition at line 606 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInput , class TOutput >
otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::LAIFromNDVILogarithmic ( )
inline

Definition at line 609 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput , class TOutput >
const double& otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::GetExtionctionCoefficient ( ) const
inline
template<class TInput , class TOutput >
const double& otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::GetNdviInf ( ) const
inline
template<class TInput , class TOutput >
const double& otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::GetNdviSoil ( ) const
inline
template<class TInput , class TOutput >
otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_ExtinctionCoefficient ( 0.  71)
inline

Definition at line 610 of file otbVegetationIndicesFunctor.h.

template<class TInput , class TOutput >
otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_NdviInf ( 0.  89)
template<class TInput , class TOutput >
otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_NdviSoil ( 0.  1)
template<class TInput , class TOutput >
TOutput otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::operator() ( const itk::VariableLengthVector< TInput > &  input) const
inlineoverridevirtual

Astract method which will compute the radiometric indice

Parameters
inputA itk::VariableLengthVector<TInput> holding the pixel values for each band
Returns
The indice value as TOutput (starts at 1 for first band)

Implements otb::Functor::RadiometricIndex< TInput, TOutput >.

Definition at line 644 of file otbVegetationIndicesFunctor.h.

References otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_ExtinctionCoefficient, otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_NdviInf, otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_NdviSoil, and otb::Functor::RadiometricIndex< TInput, TOutput >::Value().

template<class TInput , class TOutput >
void otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::SetExtinctionCoefficient ( const double &  val)
inline
template<class TInput , class TOutput >
void otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::SetNdviInf ( const double &  val)
inline
template<class TInput , class TOutput >
void otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::SetNdviSoil ( const double &  val)
inline

Member Data Documentation

template<class TInput , class TOutput >
double otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_ExtinctionCoefficient
template<class TInput , class TOutput >
double otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_NdviInf
template<class TInput , class TOutput >
double otb::Functor::LAIFromNDVILogarithmic< TInput, TOutput >::m_NdviSoil

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