Orfeo Toolbox  4.2
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
otb::Functor::IB2< TInput1, TInput2, TInput3, TOutput > Class Template Reference

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

#include <otbSoilIndicesFunctor.h>

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

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 

Public Member Functions

 IB2 ()
 Constructor. More...
 
virtual ~IB2 ()
 Desctructor. More...
 
unsigned int GetGreenIndex () const
 Get Green Index. More...
 
unsigned int GetIndex (BandName::BandName band) const
 
virtual std::string GetName () const
 
unsigned int GetNIRIndex () const
 Get Nir Index. More...
 
unsigned int GetRedIndex () const
 Get Red Index. More...
 
bool operator!= (const GAndRAndNirIndexBase &) const
 
TOutput operator() (const InputVectorType &inputVector) const
 
TOutput operator() (const TInput1 &g, const TInput2 &r, const TInput2 &nir) const
 
bool operator== (const GAndRAndNirIndexBase &other) const
 
void SetGreenIndex (unsigned int channel)
 Set Green Index. More...
 
void SetIndex (BandName::BandName band, unsigned int channel)
 
void SetNIRIndex (unsigned int channel)
 Set Nir Index. More...
 
void SetRedIndex (unsigned int channel)
 Set Red Index. More...
 

Protected Member Functions

TOutput Evaluate (const TInput1 &pGreen, const TInput2 &pRed, const TInput2 &pNir) const
 

Protected Attributes

double m_EpsilonToBeConsideredAsZero
 

Detailed Description

template<class TInput1, class TInput2, class TInput3, class TOutput>
class otb::Functor::IB2< TInput1, TInput2, TInput3, TOutput >

This functor computes the Brilliance Index (IB2)

[ ]

Definition at line 388 of file otbSoilIndicesFunctor.h.

Member Typedef Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
typedef itk::VariableLengthVector<TInput1> otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::InputVectorType
inherited

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

Definition at line 153 of file otbSoilIndicesFunctor.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 398 of file otbSoilIndicesFunctor.h.

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

Desctructor.

Definition at line 400 of file otbSoilIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::IB2< TInput1, TInput2, TInput3, TOutput >::Evaluate ( const TInput1 &  pGreen,
const TInput2 &  pRed,
const TInput2 &  pNir 
) const
inlineprotectedvirtual
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetGreenIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex ( BandName::BandName  band) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual std::string otb::Functor::IB2< TInput1, TInput2, TInput3, TOutput >::GetName ( ) const
inlinevirtual

Return the index name

Implements otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >.

Definition at line 392 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetNIRIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetRedIndex ( ) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::operator!= ( const GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput > &  ) const
inlineinherited

Definition at line 156 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const InputVectorType inputVector) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const TInput1 &  g,
const TInput2 &  r,
const TInput2 &  nir 
) const
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::operator== ( const GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput > &  other) const
inlineinherited

Definition at line 161 of file otbSoilIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::SetGreenIndex ( unsigned int  channel)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::SetNIRIndex ( unsigned int  channel)
inlineinherited
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::SetRedIndex ( unsigned int  channel)
inlineinherited

Member Data Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::m_EpsilonToBeConsideredAsZero
protectedinherited

Definition at line 256 of file otbSoilIndicesFunctor.h.


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

Generated at Sat Jul 19 2014 19:19:09 for Orfeo Toolbox with doxygen 1.8.3.1