otb::Functor::NDWI2< TInput, TOutput > Class Template Reference

#include <otbWaterIndicesFunctor.h>

Inheritance diagram for otb::Functor::NDWI2< TInput, TOutput >:

Collaboration diagram for otb::Functor::NDWI2< TInput, TOutput >:

Public Member Functions
	NDWI2 ()
TOutput	operator() (const itk::VariableLengthVector< TInput > &input) const override
Public Member Functions inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
	RadiometricIndex (const std::set< BandNameType > &requiredBands)
virtual	~RadiometricIndex ()=default
std::set< BandNameType >	GetRequiredBands () const
void	SetBandIndex (BandNameType band, vcl_size_t index)
void	SetBandsIndices (const std::map< BandNameType, vcl_size_t > &indicesMap)
vcl_size_t	GetBandIndex (BandNameType band) const

Additional Inherited Members
Public Types inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
using	BandNameType = CommonBandNames
using	InputType = TInput
using	OutputType = TOutput
using	PixelType = itk::VariableLengthVector< InputType >
Static Public Attributes inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
static constexpr double	Epsilon = 0.0000001
static constexpr vcl_size_t	NumberOfBands = static_cast<vcl_size_t>(BandNameType::MAX)
Protected Member Functions inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
vcl_size_t	UncheckedBandIndex (BandNameType band) const
double	Value (BandNameType band, const itk::VariableLengthVector< TInput > &input) const

Detailed Description

template<class TInput, class TOutput>
class otb::Functor::NDWI2< TInput, TOutput >

This functor computes the Normalized Difference Water Index (NDWI2)

[McFeeters, 1996 ]

Definition at line 78 of file otbWaterIndicesFunctor.h.

Constructor & Destructor Documentation

NDWI2()

template<class TInput , class TOutput >

otb::Functor::NDWI2< TInput, TOutput >::NDWI2 ( )

inline

Definition at line 81 of file otbWaterIndicesFunctor.h.

Member Function Documentation

operator()()

template<class TInput , class TOutput >

TOutput otb::Functor::NDWI2< TInput, TOutput >::operator() ( const itk::VariableLengthVector< TInput > &  input ) const

inlineoverridevirtual

Astract method which will compute the radiometric indice

Parameters

input

A itk::VariableLengthVector<TInput> holding the pixel values for each band

Returns

The indice value as TOutput (starts at 1 for first band)

Implements otb::Functor::RadiometricIndex< TInput, TOutput >.

Definition at line 85 of file otbWaterIndicesFunctor.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::Value().

---

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

• otbWaterIndicesFunctor.h