Orfeo Toolbox  4.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput > Class Template Referenceabstract

Base class for R And NIR based Index. More...

#include <otbVegetationIndicesFunctor.h>

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

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 

Public Member Functions

 RAndNIRIndexBase ()
 Constructor. More...
 
virtual ~RAndNIRIndexBase ()
 Desctructor. More...
 
unsigned int GetIndex (BandName::BandName band) const
 
virtual std::string GetName () const =0
 
unsigned int GetNIRIndex () const
 Get NIR Index. More...
 
unsigned int GetRedIndex () const
 Get Red Index. More...
 
bool operator!= (const RAndNIRIndexBase &) const
 
TOutput operator() (const InputVectorType &inputVector) const
 
TOutput operator() (const TInput1 &r, const TInput2 &nir) const
 
bool operator== (const RAndNIRIndexBase &other) const
 
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

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

Protected Attributes

double m_EpsilonToBeConsideredAsZero
 

Private Attributes

unsigned int m_NIRIndex
 
unsigned int m_RedIndex
 

Detailed Description

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

Base class for R 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 44 of file otbVegetationIndicesFunctor.h.

Member Typedef Documentation

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

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

Definition at line 49 of file otbVegetationIndicesFunctor.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 74 of file otbVegetationIndicesFunctor.h.

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

Desctructor.

Definition at line 76 of file otbVegetationIndicesFunctor.h.

Member Function Documentation

template<class TInput1, class TInput2, class TOutput>
virtual TOutput otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  r,
const TInput2 &  nir 
) const
protectedpure virtual
template<class TInput1, class TInput2, class TOutput>
unsigned int otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::GetIndex ( BandName::BandName  band) const
inline

Get index, generic method

Definition at line 91 of file otbVegetationIndicesFunctor.h.

template<class TInput1, class TInput2, class TOutput>
virtual std::string otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::GetName ( ) const
pure virtual
template<class TInput1, class TInput2, class TOutput>
unsigned int otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::GetNIRIndex ( ) const
inline

Get NIR Index.

Definition at line 119 of file otbVegetationIndicesFunctor.h.

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

Get Red Index.

Definition at line 109 of file otbVegetationIndicesFunctor.h.

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

Definition at line 52 of file otbVegetationIndicesFunctor.h.

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

Definition at line 63 of file otbVegetationIndicesFunctor.h.

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

Definition at line 69 of file otbVegetationIndicesFunctor.h.

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

Definition at line 57 of file otbVegetationIndicesFunctor.h.

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

Set index, generic method

Definition at line 79 of file otbVegetationIndicesFunctor.h.

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

Member Data Documentation

template<class TInput1, class TInput2, class TOutput>
double otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::m_EpsilonToBeConsideredAsZero
protected
template<class TInput1, class TInput2, class TOutput>
unsigned int otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::m_NIRIndex
private
template<class TInput1, class TInput2, class TOutput>
unsigned int otb::Functor::RAndNIRIndexBase< TInput1, TInput2, TOutput >::m_RedIndex
private

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

Generated at Sat Mar 8 2014 19:08:32 for Orfeo Toolbox with doxygen 1.8.3.1