OTB: otb::Functor::LAIFromReflectancesLinear< TInput, TOutput > Class Template Reference

OTB 9.1.1

Orfeo Toolbox

#include <otbVegetationIndicesFunctor.h>

Inheritance diagram for otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >:

Collaboration diagram for otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >:

Public Member Functions
const double &	GetNirCoef () const

const double &	GetRedCoef () const

	LAIFromReflectancesLinear ()

TOutput	operator() (const itk::VariableLengthVector< TInput > &input) const override

void	SetNirCoef (const double &val)

void	SetRedCoef (const double &val)

Public Member Functions inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
	RadiometricIndex (const std::set< BandNameType > &requiredBands)

virtual	~RadiometricIndex ()=default

std::set< BandNameType >	GetRequiredBands () 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_NirCoef

double	m_RedCoef

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::LAIFromReflectancesLinear< TInput, TOutput >

computes the LAI from reflectances

This functor computes the LAI from reflectances using a linear relationship. $LAI = \beta_0 + \sum_j \beta_j \rho_j$ where $\rho$ are the reflectances Default values for the parameters are taken from A. Bsaibes et al. / Remote Sensing of Environment 113 (2009) 716-729

Definition at line 682 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

◆ LAIFromReflectancesLinear()

template<class TInput , class TOutput >

otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::LAIFromReflectancesLinear ( )

inline

Definition at line 685 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

◆ GetNirCoef()

template<class TInput , class TOutput >

const double& otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::GetNirCoef ( ) const

inline

Definition at line 704 of file otbVegetationIndicesFunctor.h.

References otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_NirCoef.

◆ GetRedCoef()

template<class TInput , class TOutput >

const double& otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::GetRedCoef ( ) const

inline

Definition at line 694 of file otbVegetationIndicesFunctor.h.

References otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_RedCoef.

◆ operator()()

template<class TInput , class TOutput >

TOutput otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::operator() ( const itk::VariableLengthVector< TInput > & input ) const

inlineoverridevirtual

Astract method which will compute the radiometric indice

Parameters

input A 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 709 of file otbVegetationIndicesFunctor.h.

References otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_NirCoef, otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_RedCoef, and otb::Functor::RadiometricIndex< TInput, TOutput >::Value().

◆ SetNirCoef()

template<class TInput , class TOutput >

void otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::SetNirCoef ( const double & val )

inline

Definition at line 699 of file otbVegetationIndicesFunctor.h.

References otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_NirCoef.

◆ SetRedCoef()

template<class TInput , class TOutput >

void otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::SetRedCoef ( const double & val )

inline

Definition at line 689 of file otbVegetationIndicesFunctor.h.

References otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_RedCoef.

Member Data Documentation

◆ m_NirCoef

template<class TInput , class TOutput >

double otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_NirCoef

Definition at line 718 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::GetNirCoef(), otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::operator()(), and otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::SetNirCoef().

◆ m_RedCoef

template<class TInput , class TOutput >

double otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::m_RedCoef

Definition at line 717 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::GetRedCoef(), otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::operator()(), and otb::Functor::LAIFromReflectancesLinear< TInput, TOutput >::SetRedCoef().

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

otbVegetationIndicesFunctor.h