Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::Functor::MNDWI< TInput1, TInput2, TOutput > Class Template Reference

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

#include <otbWaterIndicesFunctor.h>

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

Public Types

typedef WaterIndexFunctor
< TInput1, TInput2, TOutput > 
WIFunctorType
 
- Public Types inherited from otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >
typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 

Public Member Functions

 MNDWI ()
 Constructor. More...
 
virtual ~MNDWI ()
 Desctructor. More...
 
unsigned int GetGIndex () const
 Get Index G. More...
 
unsigned int GetIndex (BandName::BandName band) const
 
unsigned int GetMIRIndex () const
 Get Index MIR. More...
 
virtual std::string GetName () const
 
WIFunctorType GetWIFunctor (void) const
 
void SetGIndex (unsigned int channel)
 Set Index G. More...
 
void SetIndex (BandName::BandName band, unsigned int channel)
 
void SetMIRIndex (unsigned int channel)
 Set Index MIR. More...
 
- Public Member Functions inherited from otb::Functor::WaterIndexBase< TInput1, TInput2, TOutput >
 WaterIndexBase ()
 Constructor. More...
 
virtual ~WaterIndexBase ()
 Desctructor. More...
 
unsigned int GetIndex1 () const
 Get Index 1. More...
 
unsigned int GetIndex2 () const
 Get Index 2. More...
 
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 &g, const TInput2 &mir) const
 

Private Attributes

WIFunctorType m_WIFunctor
 

Detailed Description

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

This functor computes the Modified Normalized Difference Water Index (MNDWI)

[Xu & al., 2006 ]

Definition at line 356 of file otbWaterIndicesFunctor.h.

Member Typedef Documentation

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

Definition at line 365 of file otbWaterIndicesFunctor.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 367 of file otbWaterIndicesFunctor.h.

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

Desctructor.

Definition at line 369 of file otbWaterIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >
TOutput otb::Functor::MNDWI< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  g,
const TInput2 &  mir 
) const
inlineprotectedvirtual
template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetGIndex ( ) const
inline
template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetIndex ( BandName::BandName  band) const
inline
template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetMIRIndex ( ) const
inline
template<class TInput1 , class TInput2 , class TOutput >
virtual std::string otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetName ( void  ) const
inlinevirtual

Return the index name

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

Definition at line 360 of file otbWaterIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >
WIFunctorType otb::Functor::MNDWI< TInput1, TInput2, TOutput >::GetWIFunctor ( void  ) const
inline
template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::MNDWI< TInput1, TInput2, TOutput >::SetGIndex ( unsigned int  channel)
inline
template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::MNDWI< TInput1, TInput2, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inline
template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::MNDWI< TInput1, TInput2, TOutput >::SetMIRIndex ( unsigned int  channel)
inline

Member Data Documentation

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

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