This functor computes the Perpendicular Vegetation Index (PVI) More...

#include <otbVegetationIndicesFunctor.h>

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

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

Public Types
typedef itk::VariableLengthVector < TInput1 >	InputVectorType

Public Member Functions
	PVI ()

virtual	~PVI ()

double	GetA (void) const

double	GetB (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...

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	SetA (const double A)

void	SetB (const double B)

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...

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

Protected Attributes
double	m_EpsilonToBeConsideredAsZero

Private Attributes
double	m_A

double	m_B

double	m_Coeff

Detailed Description

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

This functor computes the Perpendicular Vegetation Index (PVI)

[Richardson et Wiegand, 1977]

Default values for A and B are from C. L. Wiegand, A. J. Richardson, D. E. Escobar, and A. H. Gerbermann, "Vegetation Indices in Crop Assessments", REMOTE SENS. ENVIRON. 35:105-119 (1991)

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

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 , class TOutput >

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

inline

Definition at line 486 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

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

inlinevirtual

Definition at line 487 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >

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

inlineprotectedvirtual

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

Definition at line 507 of file otbVegetationIndicesFunctor.h.

References otb::Functor::PVI< TInput1, TInput2, TOutput >::m_A, otb::Functor::PVI< TInput1, TInput2, TOutput >::m_B, and otb::Functor::PVI< TInput1, TInput2, TOutput >::m_Coeff.

template<class TInput1 , class TInput2 , class TOutput >

double otb::Functor::PVI< TInput1, TInput2, TOutput >::GetA ( void ) const

inline

Definition at line 494 of file otbVegetationIndicesFunctor.h.

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

template<class TInput1 , class TInput2 , class TOutput >

double otb::Functor::PVI< TInput1, TInput2, TOutput >::GetB ( void ) const

inline

Definition at line 502 of file otbVegetationIndicesFunctor.h.

References otb::Functor::PVI< TInput1, TInput2, TOutput >::m_B.

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::PVI< TInput1, TInput2, TOutput >::GetName ( ) const

inlinevirtual

Return the index name

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

Definition at line 481 of file otbVegetationIndicesFunctor.h.

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>

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::PVI< TInput1, TInput2, TOutput >::SetA ( const double A )

inline

Set/Get A and B parameters

Definition at line 489 of file otbVegetationIndicesFunctor.h.

References otb::Functor::PVI< TInput1, TInput2, TOutput >::m_A, and otb::Functor::PVI< TInput1, TInput2, TOutput >::m_Coeff.

template<class TInput1 , class TInput2 , class TOutput >

void otb::Functor::PVI< TInput1, TInput2, TOutput >::SetB ( const double B )

inline

Definition at line 498 of file otbVegetationIndicesFunctor.h.

References otb::Functor::PVI< TInput1, TInput2, TOutput >::m_B.

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

Member Data Documentation

template<class TInput1 , class TInput2 , class TOutput >

double otb::Functor::PVI< TInput1, TInput2, TOutput >::m_A

private

A and B parameters

Definition at line 517 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::PVI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::PVI< TInput1, TInput2, TOutput >::GetA(), and otb::Functor::PVI< TInput1, TInput2, TOutput >::SetA().

template<class TInput1 , class TInput2 , class TOutput >

double otb::Functor::PVI< TInput1, TInput2, TOutput >::m_B

private

Definition at line 518 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::PVI< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::PVI< TInput1, TInput2, TOutput >::GetB(), and otb::Functor::PVI< TInput1, TInput2, TOutput >::SetB().

template<class TInput1 , class TInput2 , class TOutput >

double otb::Functor::PVI< TInput1, TInput2, TOutput >::m_Coeff

private

Denominator, pre-calculed when the A variable is set

Definition at line 520 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::PVI< TInput1, TInput2, TOutput >::Evaluate(), and otb::Functor::PVI< TInput1, TInput2, TOutput >::SetA().

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

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::PVI< 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::PVI< TInput1, TInput2, TOutput >