otb::Functor::SRWI< TInput1, TInput2, TOutput > Class Template Reference

This functor computes the Simple Ratio Water Index (SRWI) More...

#include <otbWaterIndicesFunctor.h>

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

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

Public Types
typedef itk::VariableLengthVector < TInput1 >	InputVectorType

Public Member Functions
	SRWI ()
virtual	~SRWI ()
unsigned int	GetIndex1 () const
	Get Index 1. More...
unsigned int	GetIndex2 () const
	Get Index 2. More...
virtual std::string	GetName () const
bool	operator!= (const WaterIndexBase &) const
TOutput	operator() (const InputVectorType &inputVector) const
TOutput	operator() (const TInput1 &id1, const TInput2 &id2) const
bool	operator== (const WaterIndexBase &other) const
void	SetIndex1 (unsigned int channel)
	Set Index 1. More...
void	SetIndex2 (unsigned int channel)
	Set Index 2. More...

Protected Member Functions
TOutput	Evaluate (const TInput1 &rho860, const TInput2 &rho1240) const

Detailed Description

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

This functor computes the Simple Ratio Water Index (SRWI)

For MODIS bands 860 & 1240

[Zarco-Tejada 2001]

Definition at line 153 of file otbWaterIndicesFunctor.h.

Member Typedef Documentation

template<class TInput1, class TInput2, class TOutput>

typedef itk::VariableLengthVector<TInput1> otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::InputVectorType

inherited

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

Definition at line 48 of file otbWaterIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 , class TOutput >

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

inline

Definition at line 162 of file otbWaterIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

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

inlinevirtual

Definition at line 163 of file otbWaterIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >

TOutput otb::Functor::SRWI< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  rho860, const TInput2 &  rho1240  ) const

inlineprotectedvirtual

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

Definition at line 165 of file otbWaterIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

unsigned int otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::GetIndex1 ( ) const

inlineinherited

Get Index 1.

Definition at line 83 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::NDWI2< double, double, double >::GetGIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetGIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDWI2< double, double, double >::GetIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDPI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDTI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDPI< TInput1, TInput2, TOutput >::GetMIRIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetNIRIndex(), and otb::Functor::NDTI< TInput1, TInput2, TOutput >::GetRIndex().

template<class TInput1, class TInput2, class TOutput>

unsigned int otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::GetIndex2 ( ) const

inlineinherited

Get Index 2.

Definition at line 93 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::NDPI< TInput1, TInput2, TOutput >::GetGIndex(), otb::Functor::NDTI< TInput1, TInput2, TOutput >::GetGIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDWI2< double, double, double >::GetIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDPI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDTI< TInput1, TInput2, TOutput >::GetIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetMIRIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetMIRIndex(), and otb::Functor::NDWI2< double, double, double >::GetNIRIndex().

template<class TInput1 , class TInput2 , class TOutput >

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

inlinevirtual

Return the index name

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

Definition at line 157 of file otbWaterIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

bool otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::operator!= ( const WaterIndexBase< TInput1, TInput2, TOutput > &  ) const

inlineinherited

Definition at line 51 of file otbWaterIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

TOutput otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::operator() ( const InputVectorType &  inputVector ) const

inlineinherited

Definition at line 62 of file otbWaterIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

TOutput otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::operator() ( const TInput1 &  id1, const TInput2 &  id2  ) const

inlineinherited

Definition at line 68 of file otbWaterIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

bool otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::operator== ( const WaterIndexBase< TInput1, TInput2, TOutput > &  other ) const

inlineinherited

Definition at line 56 of file otbWaterIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>

void otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::SetIndex1 ( unsigned int  channel )

inlineinherited

Set Index 1.

Definition at line 78 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::NDWI2< double, double, double >::SetGIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::SetGIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDWI2< double, double, double >::SetIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDPI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDTI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDPI< TInput1, TInput2, TOutput >::SetMIRIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::SetNIRIndex(), and otb::Functor::NDTI< TInput1, TInput2, TOutput >::SetRIndex().

template<class TInput1, class TInput2, class TOutput>

void otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::SetIndex2 ( unsigned int  channel )

inlineinherited

Set Index 2.

Definition at line 88 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::NDPI< TInput1, TInput2, TOutput >::SetGIndex(), otb::Functor::NDTI< TInput1, TInput2, TOutput >::SetGIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDWI2< double, double, double >::SetIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDPI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDTI< TInput1, TInput2, TOutput >::SetIndex(), otb::Functor::NDWI< TInput1, TInput2, TOutput >::SetMIRIndex(), otb::Functor::MNDWI< TInput1, TInput2, TOutput >::SetMIRIndex(), and otb::Functor::NDWI2< double, double, double >::SetNIRIndex().

---

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

• otbWaterIndicesFunctor.h