Orfeo Toolbox  3.16
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::Functor::NDWI< TInput1, TInput2, TOutput > Class Template Reference
Radiometry modules

This functor computes the Normalized Difference Water Index (NDWI) More...

#include <otbWaterIndicesFunctor.h>

+ Inheritance diagram for otb::Functor::NDWI< TInput1, TInput2, TOutput >:
+ Collaboration diagram for otb::Functor::NDWI< TInput1, TInput2, TOutput >:

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 		InputVectorType
 
typedef WaterIndexFunctor
< TInput1, TInput2, TOutput > 		WIFunctorType
 

Public Member Functions

 NDWI ()
 Constructor. More...
 
virtual ~NDWI ()
 Desctructor. More...
 
unsigned int GetIndex (BandName::BandName band) const
 
unsigned int GetIndex1 () const
 Get Index 1. More...
 
unsigned int GetIndex2 () const
 Get Index 2. More...
 
unsigned int GetMIRIndex () const
 Get Index MIR. More...
 
virtual std::string GetName () const
 
unsigned int GetNIRIndex () const
 Get Index NIR. More...
 
WIFunctorType GetWIFunctor (void) 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 SetIndex (BandName::BandName band, unsigned int channel)
 
void SetIndex1 (unsigned int channel)
 Set Index 1. More...
 
void SetIndex2 (unsigned int channel)
 Set Index 2. More...
 
void SetMIRIndex (unsigned int channel)
 Set Index MIR. More...
 
void SetNIRIndex (unsigned int channel)
 Set Index NIR. More...
 

Protected Member Functions

TOutput Evaluate (const TInput1 &nir, const TInput2 &mir) const
 

Private Attributes

WIFunctorType m_WIFunctor
 

Detailed Description

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

This functor computes the Normalized Difference Water Index (NDWI)

Also called : NDII (Normalized Difference Infrared Index) LSWI (Land Surface Water Index) NDWI (Normalized Difference Moisture Index)

[Gao, 1996 ]

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

template<class TInput1 , class TInput2 , class TOutput >
typedef WaterIndexFunctor<TInput1, TInput2, TOutput> otb::Functor::NDWI< TInput1, TInput2, TOutput >::WIFunctorType

Definition at line 199 of file otbWaterIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 , class TOutput >
otb::Functor::NDWI< TInput1, TInput2, TOutput >::NDWI ( )
inline

Constructor.

Definition at line 201 of file otbWaterIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >
virtual otb::Functor::NDWI< TInput1, TInput2, TOutput >::~NDWI ( )
inlinevirtual

Desctructor.

Definition at line 203 of file otbWaterIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >
TOutput otb::Functor::NDWI< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  nir,
const TInput2 &  mir 
) const
inlineprotectedvirtual

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

Definition at line 255 of file otbWaterIndicesFunctor.h.

References otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetWIFunctor().

template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetIndex ( BandName::BandName  band) const
inline

Get index, generic method

Definition at line 242 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::GetIndex1(), otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::GetIndex2(), otb::BandName::MIR, and otb::BandName::NIR.

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 >
unsigned int otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetMIRIndex ( ) const
inline

Get Index MIR.

Definition at line 224 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::GetIndex2().

template<class TInput1 , class TInput2 , class TOutput >
virtual std::string otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetName ( ) const
inlinevirtual

Return the index name

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

Definition at line 194 of file otbWaterIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetNIRIndex ( ) const
inline

Get Index NIR.

Definition at line 214 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::GetIndex1().

template<class TInput1 , class TInput2 , class TOutput >
WIFunctorType otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetWIFunctor ( void  ) const
inline

Definition at line 204 of file otbWaterIndicesFunctor.h.

References otb::Functor::NDWI< TInput1, TInput2, TOutput >::m_WIFunctor.

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

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::NDWI< TInput1, TInput2, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inline

Set index, generic method

Definition at line 230 of file otbWaterIndicesFunctor.h.

References otb::BandName::MIR, otb::BandName::NIR, otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::SetIndex1(), and otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::SetIndex2().

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

template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::NDWI< TInput1, TInput2, TOutput >::SetMIRIndex ( unsigned int  channel)
inline

Set Index MIR.

Definition at line 219 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::SetIndex2().

template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::NDWI< TInput1, TInput2, TOutput >::SetNIRIndex ( unsigned int  channel)
inline

Set Index NIR.

Definition at line 209 of file otbWaterIndicesFunctor.h.

References otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >::SetIndex1().

Member Data Documentation

template<class TInput1 , class TInput2 , class TOutput >
WIFunctorType otb::Functor::NDWI< TInput1, TInput2, TOutput >::m_WIFunctor
private

Definition at line 261 of file otbWaterIndicesFunctor.h.

Referenced by otb::Functor::NDWI< TInput1, TInput2, TOutput >::GetWIFunctor().

The documentation for this class was generated from the following file:
Generated at Sun May 19 2013 04:29:07 for Orfeo Toolbox with doxygen 1.8.3.1