This functor computes the Brilliance Index (IB) More...

#include <otbSoilIndicesFunctor.h>

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

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

Public Types
typedef itk::VariableLengthVector < TInput1 >	InputVectorType

Public Member Functions
	IB ()
	Constructor. More...

virtual	~IB ()
	Desctructor. More...

unsigned int	GetGreenIndex () const
	Get Green Index. More...

unsigned int	GetIndex (BandName::BandName band) const

virtual std::string	GetName () const

unsigned int	GetRedIndex () const
	Get Red Index. More...

bool	operator!= (const GAndRIndexBase &) const

TOutput	operator() (const InputVectorType &inputVector) const

TOutput	operator() (const TInput1 &g, const TInput2 &r) const

bool	operator== (const GAndRIndexBase &other) const

void	SetGreenIndex (unsigned int channel)
	Set Green Index. More...

void	SetIndex (BandName::BandName band, unsigned int channel)

void	SetRedIndex (unsigned int channel)
	Set Red Index. More...

Protected Member Functions
TOutput	Evaluate (const TInput1 &pGreen, const TInput2 &pRed) const

Protected Attributes
double	m_EpsilonToBeConsideredAsZero

Detailed Description

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

This functor computes the Brilliance Index (IB)

[ ]

Definition at line 355 of file otbSoilIndicesFunctor.h.

Member Typedef Documentation

template<class TInput1 , class TInput2 , class TOutput >

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

inherited

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

Definition at line 51 of file otbSoilIndicesFunctor.h.

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 , class TOutput >

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

inline

Constructor.

Definition at line 365 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

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

inlinevirtual

Desctructor.

Definition at line 367 of file otbSoilIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >

TOutput otb::Functor::IB< TInput1, TInput2, TOutput >::Evaluate	(	const TInput1 &	pGreen,
		const TInput2 &	pRed
	)		const

inlineprotectedvirtual

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

Definition at line 370 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

unsigned int otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::GetGreenIndex ( ) const

inlineinherited

Get Green Index.

Definition at line 86 of file otbSoilIndicesFunctor.h.

References otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_GreenIndex.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Get index, generic method

Definition at line 114 of file otbSoilIndicesFunctor.h.

References otb::BandName::GREEN, otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_GreenIndex, otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_RedIndex, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TOutput >

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

inlinevirtual

Return the index name

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

Definition at line 359 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

unsigned int otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::GetRedIndex ( ) const

inlineinherited

Get Red Index.

Definition at line 96 of file otbSoilIndicesFunctor.h.

References otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_RedIndex.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Definition at line 54 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Definition at line 65 of file otbSoilIndicesFunctor.h.

References otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::Evaluate(), otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_GreenIndex, and otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_RedIndex.

template<class TInput1 , class TInput2 , class TOutput >

TOutput otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::operator()	(	const TInput1 &	g,
		const TInput2 &	r
	)		const

inlineinherited

Definition at line 71 of file otbSoilIndicesFunctor.h.

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

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Definition at line 59 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TOutput >

void otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::SetGreenIndex ( unsigned int channel )

inlineinherited

Set Green Index.

Definition at line 81 of file otbSoilIndicesFunctor.h.

References otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_GreenIndex.

template<class TInput1 , class TInput2 , class TOutput >

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

inlineinherited

Set index, generic method

Definition at line 102 of file otbSoilIndicesFunctor.h.

References otb::BandName::GREEN, otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_GreenIndex, otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_RedIndex, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TOutput >

void otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::SetRedIndex ( unsigned int channel )

inlineinherited

Set Red Index.

Definition at line 91 of file otbSoilIndicesFunctor.h.

References otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_RedIndex.

Member Data Documentation

template<class TInput1 , class TInput2 , class TOutput >

double otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::m_EpsilonToBeConsideredAsZero

protectedinherited

Definition at line 133 of file otbSoilIndicesFunctor.h.

Referenced by otb::Functor::IR< TInput1, TInput2, TOutput >::Evaluate(), and otb::Functor::IC< TInput1, TInput2, TOutput >::Evaluate().

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

otbSoilIndicesFunctor.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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