Orfeo Toolbox  3.16
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput > Class Template Reference
Radiometry modules

base class for R, B And NIR based Index Implement operators for UnaryFunctorImageFilter templated with a VectorImage and BinaryFunctorImageFilter templated with single images. Subclasses should NOT overload operators, they must re-implement the Evaluate() method. More...

#include <otbVegetationIndicesFunctor.h>

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

List of all members.

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 		InputVectorType

Public Member Functions

 RAndBAndNIRIndexBase ()
 Constructor.
virtual ~RAndBAndNIRIndexBase ()
 Desctructor.
unsigned int GetBlueIndex () const
 Get Blue Index.
unsigned int GetIndex (BandName::BandName band) const
virtual std::string GetName () const =0
unsigned int GetNIRIndex () const
 Get NIR Index.
unsigned int GetRedIndex () const
 Get Red Index.
bool operator!= (const RAndBAndNIRIndexBase &) const
TOutput operator() (const InputVectorType &inputVector)
TOutput operator() (const TInput1 &r, const TInput2 &b, const TInput2 &nir)
bool operator== (const RAndBAndNIRIndexBase &other) const
void SetBlueIndex (unsigned int channel)
 Set Blue Index.
void SetIndex (BandName::BandName band, unsigned int channel)
void SetNIRIndex (unsigned int channel)
 Set NIR Index.
void SetRedIndex (unsigned int channel)
 Set Red Index.

Protected Member Functions

virtual TOutput Evaluate (const TInput1 &r, const TInput2 &b, const TInput3 &nir) const =0

Protected Attributes

double m_EpsilonToBeConsideredAsZero

Private Attributes

unsigned int m_BlueIndex
unsigned int m_NIRIndex
unsigned int m_RedIndex

Detailed Description

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

base class for R, B And NIR based Index Implement operators for UnaryFunctorImageFilter templated with a VectorImage and BinaryFunctorImageFilter templated with single images. Subclasses should NOT overload operators, they must re-implement the Evaluate() method.

Definition at line 149 of file otbVegetationIndicesFunctor.h.

Member Typedef Documentation

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

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

Definition at line 154 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 181 of file otbVegetationIndicesFunctor.h.

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

Desctructor.

Definition at line 183 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual TOutput otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::Evaluate ( const TInput1 &  r,
const TInput2 &  b,
const TInput3 &  nir 
) const
protectedpure virtual

Implemented in otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >, otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >, and otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >.

Referenced by otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator()().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetBlueIndex ( ) const
inline

Get Blue Index.

Definition at line 234 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex ( BandName::BandName  band) const
inline

Get index, generic method

Definition at line 202 of file otbVegetationIndicesFunctor.h.

References otb::BandName::BLUE, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex, otb::BandName::NIR, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual std::string otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetName ( ) const
pure virtual

Return the index name

Implemented in otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >, otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >, and otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetNIRIndex ( ) const
inline

Get NIR Index.

Definition at line 245 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetRedIndex ( ) const
inline

Get Red Index.

Definition at line 224 of file otbVegetationIndicesFunctor.h.

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

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator!= ( const RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput > &  ) const
inline

Definition at line 157 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const InputVectorType &  inputVector)
inline

Definition at line 169 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex, and otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
TOutput otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator() ( const TInput1 &  r,
const TInput2 &  b,
const TInput2 &  nir 
)
inline

Definition at line 176 of file otbVegetationIndicesFunctor.h.

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

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
bool otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator== ( const RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput > &  other) const
inline

Definition at line 163 of file otbVegetationIndicesFunctor.h.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetBlueIndex ( unsigned int  channel)
inline

Set Blue Index.

Definition at line 229 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inline

Set index, generic method

Definition at line 186 of file otbVegetationIndicesFunctor.h.

References otb::BandName::BLUE, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex, otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex, otb::BandName::NIR, and otb::BandName::RED.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetNIRIndex ( unsigned int  channel)
inline

Set NIR Index.

Definition at line 240 of file otbVegetationIndicesFunctor.h.

References otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetRedIndex ( unsigned int  channel)
inline

Set Red Index.

Definition at line 219 of file otbVegetationIndicesFunctor.h.

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

Member Data Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_BlueIndex
private

Definition at line 261 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetBlueIndex(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator()(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetBlueIndex(), and otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
double otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_EpsilonToBeConsideredAsZero
protected

Definition at line 257 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::ARVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), otb::Functor::TSARVI< TInput1, TInput2, TInput3, TOutput >::Evaluate(), and otb::Functor::EVI< TInput1, TInput2, TInput3, TOutput >::Evaluate().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_NIRIndex
private

Definition at line 262 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetNIRIndex(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator()(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex(), and otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetNIRIndex().

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::m_RedIndex
private

Definition at line 260 of file otbVegetationIndicesFunctor.h.

Referenced by otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::GetRedIndex(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::operator()(), otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex(), and otb::Functor::RAndBAndNIRIndexBase< TInput1, TInput2, TInput3, TOutput >::SetRedIndex().

The documentation for this class was generated from the following file:
Generated at Sun Feb 3 2013 04:26:31 for Orfeo Toolbox with doxygen 1.8.1.1