This functor computes the Modified Soil Adjusted Vegetation Index (MSAVI) More...

#include <otbVegetationIndicesFunctor.h>

Inheritance diagram for otb::Functor::MSAVI< TInput1, TInput2, TOutput >:

Collaboration diagram for otb::Functor::MSAVI< TInput1, TInput2, TOutput >:

Public Types
typedef itk::VariableLengthVector < TInput1 >	InputVectorType

typedef NDVI< TInput1, TInput2, TOutput >	NDVIFunctorType

typedef SAVI< TInput1, TInput2, TOutput >	SAVIFunctorType

typedef WDVI< TInput1, TInput2, TOutput >	WDVIFunctorType

Public Member Functions
	MSAVI ()

virtual	~MSAVI ()

unsigned int	GetIndex (BandName::BandName band) const

virtual std::string	GetName () const

NDVIFunctorType	GetNDVI (void) const

unsigned int	GetNIRIndex () const
	Get NIR Index. More...

unsigned int	GetRedIndex () const
	Get Red Index. More...

double	GetS (void) const

WDVIFunctorType	GetWDVI (void) const

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	SetNIRIndex (unsigned int channel)
	Set NIR Index. More...

void	SetRedIndex (unsigned int channel)
	Set Red Index. More...

void	SetS (const double s)

Protected Member Functions
TOutput	Evaluate (const TInput1 &r, const TInput2 &nir) const

Protected Attributes
double	m_EpsilonToBeConsideredAsZero

Private Attributes
NDVIFunctorType	m_NDVIfunctor

double	m_S

WDVIFunctorType	m_WDVIfunctor

Detailed Description

template<class TInput1, class TInput2, class TOutput>
class otb::Functor::MSAVI< TInput1, TInput2, TOutput >

This functor computes the Modified Soil Adjusted Vegetation Index (MSAVI)

[Qi et al., 1994]

Definition at line 703 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.

template<class TInput1 , class TInput2 , class TOutput >

typedef NDVI<TInput1, TInput2, TOutput> otb::Functor::MSAVI< TInput1, TInput2, TOutput >::NDVIFunctorType

Definition at line 712 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

typedef SAVI<TInput1, TInput2, TOutput> otb::Functor::MSAVI< TInput1, TInput2, TOutput >::SAVIFunctorType

Definition at line 713 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

typedef WDVI<TInput1, TInput2, TOutput> otb::Functor::MSAVI< TInput1, TInput2, TOutput >::WDVIFunctorType

Definition at line 714 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 , class TOutput >

otb::Functor::MSAVI< TInput1, TInput2, TOutput >::MSAVI ( )

inline

Definition at line 715 of file otbVegetationIndicesFunctor.h.

References otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_S, otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_WDVIfunctor, and otb::Functor::WDVI< TInput1, TInput2, TOutput >::SetS().

template<class TInput1 , class TInput2 , class TOutput >

virtual otb::Functor::MSAVI< TInput1, TInput2, TOutput >::~MSAVI ( )

inlinevirtual

Definition at line 719 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >

TOutput otb::Functor::MSAVI< TInput1, TInput2, TOutput >::Evaluate	(	const TInput1 &	r,
		const TInput2 &	nir
	)		const

inlineprotectedvirtual

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

Definition at line 740 of file otbVegetationIndicesFunctor.h.

References otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetNDVI(), otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetWDVI(), otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::m_EpsilonToBeConsideredAsZero, and otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_S.

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 >

virtual std::string otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetName ( ) const

inlinevirtual

Return the index name

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

Definition at line 707 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

NDVIFunctorType otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetNDVI ( void ) const

inline

Definition at line 730 of file otbVegetationIndicesFunctor.h.

References otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_NDVIfunctor.

Referenced by otb::Functor::MSAVI< TInput1, TInput2, TOutput >::Evaluate().

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 >

double otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetS ( void ) const

inline

Definition at line 726 of file otbVegetationIndicesFunctor.h.

References otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_S.

template<class TInput1 , class TInput2 , class TOutput >

WDVIFunctorType otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetWDVI ( void ) const

inline

Definition at line 734 of file otbVegetationIndicesFunctor.h.

References otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_WDVIfunctor.

Referenced by otb::Functor::MSAVI< TInput1, TInput2, TOutput >::Evaluate().

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

template<class TInput1 , class TInput2 , class TOutput >

void otb::Functor::MSAVI< TInput1, TInput2, TOutput >::SetS ( const double s )

inline

Set/Get Slop of soil line

Definition at line 721 of file otbVegetationIndicesFunctor.h.

References otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_S, otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_WDVIfunctor, and otb::Functor::WDVI< TInput1, TInput2, TOutput >::SetS().

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 >

NDVIFunctorType otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_NDVIfunctor

private

Definition at line 762 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetNDVI().

template<class TInput1 , class TInput2 , class TOutput >

double otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_S

private

Slope of soil line

Definition at line 761 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::MSAVI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetS(), otb::Functor::MSAVI< TInput1, TInput2, TOutput >::MSAVI(), and otb::Functor::MSAVI< TInput1, TInput2, TOutput >::SetS().

template<class TInput1 , class TInput2 , class TOutput >

WDVIFunctorType otb::Functor::MSAVI< TInput1, TInput2, TOutput >::m_WDVIfunctor

private

Definition at line 763 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::MSAVI< TInput1, TInput2, TOutput >::GetWDVI(), otb::Functor::MSAVI< TInput1, TInput2, TOutput >::MSAVI(), and otb::Functor::MSAVI< TInput1, TInput2, TOutput >::SetS().

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

otbVegetationIndicesFunctor.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<class TInput1, class TInput2, class TOutput> class otb::Functor::MSAVI< TInput1, TInput2, TOutput >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInput1, class TInput2, class TOutput>
class otb::Functor::MSAVI< TInput1, TInput2, TOutput >