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

This functor computes the Normalized Difference Built Up Index (NDBI) More...

#include <otbBuiltUpIndicesFunctor.h>

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

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

Public Types
typedef itk::VariableLengthVector < TInput1 >	InputVectorType

Public Member Functions
	NDBI ()
	Constructor. More...
virtual	~NDBI ()
	Desctructor. More...
unsigned int	GetIndex (BandName::BandName band) const
unsigned int	GetIndex1 () const
	Get TM4 Index. More...
unsigned int	GetIndex2 () const
	Get TM5 Index. More...
virtual std::string	GetName () const
bool	operator!= (const TM4AndTM5IndexBase &) const
TOutput	operator() (const InputVectorType &inputVector) const
TOutput	operator() (const TInput1 &tm4, const TInput2 &tm5) const
bool	operator== (const TM4AndTM5IndexBase &other) const
void	SetIndex (BandName::BandName band, unsigned int channel)
void	SetIndex1 (unsigned int channel)
	Set TM4 Index. More...
void	SetIndex2 (unsigned int channel)
	Set TM5 Index. More...

Protected Member Functions
TOutput	Evaluate (const TInput1 &pTM4, const TInput2 &pTM5) const

Detailed Description

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

This functor computes the Normalized Difference Built Up Index (NDBI)

[Zha 2003]

Definition at line 145 of file otbBuiltUpIndicesFunctor.h.

Member Typedef Documentation

template<class TInput1 , class TInput2 , class TOutput >

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

inherited

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

Definition at line 48 of file otbBuiltUpIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 , class TOutput >

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

inline

Constructor.

Definition at line 155 of file otbBuiltUpIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

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

inlinevirtual

Desctructor.

Definition at line 157 of file otbBuiltUpIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >

TOutput otb::Functor::NDBI< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  pTM4, const TInput2 &  pTM5  ) const

inlineprotectedvirtual

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

Definition at line 160 of file otbBuiltUpIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

unsigned int otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::GetIndex ( BandName::BandName  band ) const

inlineinherited

Get index, generic method

Definition at line 111 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM4Index, otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM5Index, otb::BandName::NIR, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Get TM4 Index.

Definition at line 83 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM4Index.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Get TM5 Index.

Definition at line 93 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM5Index.

template<class TInput1 , class TInput2 , class TOutput >

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

inlinevirtual

Return the index name

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

Definition at line 149 of file otbBuiltUpIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Definition at line 51 of file otbBuiltUpIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Definition at line 62 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM4Index, and otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM5Index.

template<class TInput1 , class TInput2 , class TOutput >

TOutput otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::operator() ( const TInput1 &  tm4, const TInput2 &  tm5  ) const

inlineinherited

Definition at line 68 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::Evaluate().

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Definition at line 56 of file otbBuiltUpIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

void otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::SetIndex ( BandName::BandName  band, unsigned int  channel  )

inlineinherited

Set index, generic method

Definition at line 99 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM4Index, otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM5Index, otb::BandName::NIR, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Set TM4 Index.

Definition at line 78 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM4Index.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Set TM5 Index.

Definition at line 88 of file otbBuiltUpIndicesFunctor.h.

References otb::Functor::TM4AndTM5IndexBase< TInput1, TInput2, TOutput >::m_TM5Index.

---

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

• otbBuiltUpIndicesFunctor.h