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

Base class for Green And Red channels of Spot Images XS1 corresponds to the green channel XS2 corresponds to the red channel XS3 corresponds to the Nir channel XS4 corresponds to the Mir channel (for Spot 4 & 5) 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 <otbSoilIndicesFunctor.h>

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

Public Types

typedef
itk::VariableLengthVector
< TInput1 > 
InputVectorType
 

Public Member Functions

 GAndRIndexBase ()
 Constructor. More...
 
virtual ~GAndRIndexBase ()
 Desctructor. More...
 
unsigned int GetGreenIndex () const
 Get Green Index. More...
 
unsigned int GetIndex (BandName::BandName band) const
 
virtual std::string GetName () const =0
 
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

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

Protected Attributes

double m_EpsilonToBeConsideredAsZero
 

Private Attributes

unsigned int m_GreenIndex
 
unsigned int m_RedIndex
 

Detailed Description

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

Base class for Green And Red channels of Spot Images XS1 corresponds to the green channel XS2 corresponds to the red channel XS3 corresponds to the Nir channel XS4 corresponds to the Mir channel (for Spot 4 & 5) 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 46 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

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::GAndRIndexBase< TInput1, TInput2, TOutput >::GAndRIndexBase ( )
inline

Constructor.

Definition at line 76 of file otbSoilIndicesFunctor.h.

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

Desctructor.

Definition at line 78 of file otbSoilIndicesFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 , class TOutput >
virtual TOutput otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::Evaluate ( const TInput1 &  g,
const TInput2 &  r 
) const
protectedpure virtual
template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::GetGreenIndex ( ) const
inline
template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::GetIndex ( BandName::BandName  band) const
inline
template<class TInput1 , class TInput2 , class TOutput >
virtual std::string otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::GetName ( ) const
pure virtual
template<class TInput1 , class TInput2 , class TOutput >
unsigned int otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::GetRedIndex ( ) const
inline
template<class TInput1 , class TInput2 , class TOutput >
bool otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::operator!= ( const GAndRIndexBase< TInput1, TInput2, TOutput > &  ) const
inline

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
inline
template<class TInput1 , class TInput2 , class TOutput >
TOutput otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::operator() ( const TInput1 &  g,
const TInput2 &  r 
) const
inline
template<class TInput1 , class TInput2 , class TOutput >
bool otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::operator== ( const GAndRIndexBase< TInput1, TInput2, TOutput > &  other) const
inline

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)
inline
template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inline
template<class TInput1 , class TInput2 , class TOutput >
void otb::Functor::GAndRIndexBase< TInput1, TInput2, TOutput >::SetRedIndex ( unsigned int  channel)
inline

Member Data Documentation

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

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

Generated at Sat Oct 11 2014 17:26:00 for Orfeo Toolbox with doxygen 1.8.3.1