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

#include <otbSoilIndicesFunctor.h>

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

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 

Public Member Functions

 GAndRAndNirIndexBase ()
 
unsigned int GetGreenIndex () const
 
virtual std::string GetName () const =0
 
unsigned int GetNIRIndex () const
 
unsigned int GetRedIndex () const
 
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)
 
void SetIndex (BandName::BandName band, unsigned int channel)
 
void SetNIRIndex (unsigned int channel)
 
void SetRedIndex (unsigned int channel)
 
virtual ~GAndRAndNirIndexBase ()
 
unsigned int GetIndex (BandName::BandName band) const
 

Protected Member Functions

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

Protected Attributes

double m_EpsilonToBeConsideredAsZero
 

Private Attributes

unsigned int m_GreenIndex
 
unsigned int m_NIRIndex
 
unsigned int m_RedIndex
 

Detailed Description

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

Base class for Green And Red And NIR channels of Spot Images.

Definition at line 154 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

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

Definition at line 159 of file otbSoilIndicesFunctor.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 186 of file otbSoilIndicesFunctor.h.

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

Desctructor.

Definition at line 188 of file otbSoilIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual TOutput otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::Evaluate ( const TInput1 &  g,
const TInput2 &  r,
const TInput2 &  nir 
) const
protectedpure virtual
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetGreenIndex ( ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetIndex ( BandName::BandName  band) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
virtual std::string otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetName ( ) const
pure virtual

Return the index name

Implemented in otb::Functor::IB2< TInput1, TInput2, TInput3, TOutput >.

template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetNIRIndex ( ) const
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
unsigned int otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::GetRedIndex ( ) const
inline
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
inline

Definition at line 162 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
inline
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
inline
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
inline

Definition at line 167 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)
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::SetNIRIndex ( unsigned int  channel)
inline
template<class TInput1 , class TInput2 , class TInput3 , class TOutput >
void otb::Functor::GAndRAndNirIndexBase< TInput1, TInput2, TInput3, TOutput >::SetRedIndex ( unsigned int  channel)
inline

Member Data Documentation

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

Definition at line 264 of file otbSoilIndicesFunctor.h.

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

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