OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput > Class Template Reference
Thematic modules » Radiometry modulesGroup Core » | Module OTBIndices

#include <otbLandsatTMIndices.h>

+ Inheritance diagram for otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >:
+ Collaboration diagram for otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >:

Public Types

typedef bool OutputPixelType
 
typedef TInput::ValueType PrecisionType
 

Public Member Functions

virtual std::string GetName () const
 
PrecisionType GetTV1 () const
 
PrecisionType GetTV2 () const
 
 KernelSpectralRule ()
 
void SetTV1 (PrecisionType tv1)
 
void SetTV2 (PrecisionType tv2)
 
 ~KernelSpectralRule () override
 
- Public Member Functions inherited from otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >
 LandsatTMIndexBase ()
 
bool operator!= (const LandsatTMIndexBase &) const
 
bool operator== (const LandsatTMIndexBase &other) const
 
void SetIndex (BandName::LandsatTMBandNames band, unsigned int channel)
 
virtual ~LandsatTMIndexBase ()
 
unsigned int GetIndex (BandName::LandsatTMBandNames band) const
 
unsigned int GetTM1 () const
 
unsigned int GetTM2 () const
 
unsigned int GetTM3 () const
 
unsigned int GetTM4 () const
 
unsigned int GetTM5 () const
 
unsigned int GetTM60 () const
 
unsigned int GetTM61 () const
 
unsigned int GetTM62 () const
 
unsigned int GetTM7 () const
 
void SetSAT (SATType sat)
 
SATType GetSAT () const
 
void SetDegree (DegreeType deg)
 
DegreeType GetDegre () const
 
void SetReflectance (ReflectanceType ref)
 
ReflectanceType GetReflectance () const
 
double GetEpsilonToBeConsideredAsZero () const
 

Protected Member Functions

void SetMinMax (const TInput &inputPixel, PrecisionType *max13, PrecisionType *min123, PrecisionType *max123, PrecisionType *min12347, PrecisionType *max12347, PrecisionType *max234, PrecisionType *max45)
 
- Protected Member Functions inherited from otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >
TInput PrepareValues (const TInput &inputPixel)
 

Protected Attributes

PrecisionType m_TV1
 
PrecisionType m_TV2
 
- Protected Attributes inherited from otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >
double m_EpsilonToBeConsideredAsZero
 
unsigned int m_TM1
 
unsigned int m_TM2
 
unsigned int m_TM3
 
unsigned int m_TM4
 
unsigned int m_TM5
 
unsigned int m_TM60
 
unsigned int m_TM61
 
unsigned int m_TM62
 
unsigned int m_TM7
 
SATType m_SAT
 
DegreeType m_Degree
 
ReflectanceType m_Reflectance
 

Detailed Description

template<class TInput, class TOutput>
class otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >

Implementation of the Kernel Spectral rules for Landsat TM image land cover classification as described in table IV of Baraldi et al. 2006, "Automatic Spectral Rule-Based Preliminary Mapping of Calibrated Landsat TM and ETM+ Images", IEEE Trans. on Geoscience and Remote Sensing, vol 44, no 9.

This is a virtual class defining the common accessors to the 14 spectral rules

Definition at line 1132 of file otbLandsatTMIndices.h.

Member Typedef Documentation

◆ OutputPixelType

template<class TInput , class TOutput >
typedef bool otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::OutputPixelType

Definition at line 1136 of file otbLandsatTMIndices.h.

◆ PrecisionType

template<class TInput , class TOutput >
typedef TInput::ValueType otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::PrecisionType

Definition at line 1135 of file otbLandsatTMIndices.h.

Constructor & Destructor Documentation

◆ KernelSpectralRule()

template<class TInput , class TOutput >
otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::KernelSpectralRule ( )
inline

Definition at line 1144 of file otbLandsatTMIndices.h.

◆ ~KernelSpectralRule()

template<class TInput , class TOutput >
otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::~KernelSpectralRule ( )
inlineoverride

Definition at line 1147 of file otbLandsatTMIndices.h.

Member Function Documentation

◆ GetName()

template<class TInput , class TOutput >
virtual std::string otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::GetName ( ) const
inlinevirtual

Return the index name

Reimplemented in otb::Functor::LandsatTM::WetlandSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::ShadowCloudOrSnowSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::ShadowWithVegetationSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::ShadowWithBarrenLandSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::FlatResponseBarrenLandOrBuiltUpSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::BarrenLandOrBuiltUpOrCloudsSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::RangelandSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::VegetationSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::DominantBlueSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::PitbogOrGreenhouseSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::WaterOrShadowSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::SnowOrIceSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::ThinCloudsSpectralRule< TInput, TOutput >, otb::Functor::LandsatTM::ThickCloudsSpectralRule< TInput, TOutput >, and otb::Functor::LandsatTM::SpectralRuleBasedClassifier< TInput, TOutput >.

Definition at line 1139 of file otbLandsatTMIndices.h.

◆ GetTV1()

template<class TInput , class TOutput >
PrecisionType otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::GetTV1 ( ) const
inline

Definition at line 1161 of file otbLandsatTMIndices.h.

References otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::m_TV1.

◆ GetTV2()

template<class TInput , class TOutput >
PrecisionType otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::GetTV2 ( ) const
inline

Definition at line 1166 of file otbLandsatTMIndices.h.

References otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::m_TV2.

◆ SetMinMax()

template<class TInput , class TOutput >
void otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::SetMinMax ( const TInput &  inputPixel,
PrecisionType *  max13,
PrecisionType *  min123,
PrecisionType *  max123,
PrecisionType *  min12347,
PrecisionType *  max12347,
PrecisionType *  max234,
PrecisionType *  max45 
)
inlineprotected

Definition at line 1178 of file otbLandsatTMIndices.h.

References otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >::m_TM1, otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >::m_TM2, otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >::m_TM3, otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >::m_TM4, otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >::m_TM5, and otb::Functor::LandsatTM::LandsatTMIndexBase< TInput, TOutput >::m_TM7.

Referenced by otb::Functor::LandsatTM::ThickCloudsSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::ThinCloudsSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::SnowOrIceSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::PitbogOrGreenhouseSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::VegetationSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::RangelandSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::BarrenLandOrBuiltUpOrCloudsSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::FlatResponseBarrenLandOrBuiltUpSpectralRule< TInput, TOutput >::operator()(), and otb::Functor::LandsatTM::ShadowCloudOrSnowSpectralRule< TInput, TOutput >::operator()().

◆ SetTV1()

template<class TInput , class TOutput >
void otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::SetTV1 ( PrecisionType  tv1)
inline

Definition at line 1151 of file otbLandsatTMIndices.h.

References otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::m_TV1.

◆ SetTV2()

template<class TInput , class TOutput >
void otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::SetTV2 ( PrecisionType  tv2)
inline

Definition at line 1156 of file otbLandsatTMIndices.h.

References otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::m_TV2.

Member Data Documentation

◆ m_TV1

template<class TInput , class TOutput >
PrecisionType otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::m_TV1
protected

Tolerance value 1

Definition at line 1173 of file otbLandsatTMIndices.h.

Referenced by otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::GetTV1(), otb::Functor::LandsatTM::SpectralRuleBasedClassifier< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::ThickCloudsSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::ThinCloudsSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::SnowOrIceSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::PitbogOrGreenhouseSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::DominantBlueSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::VegetationSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::RangelandSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::BarrenLandOrBuiltUpOrCloudsSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::FlatResponseBarrenLandOrBuiltUpSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::ShadowWithBarrenLandSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::ShadowWithVegetationSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::ShadowCloudOrSnowSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::WetlandSpectralRule< TInput, TOutput >::operator()(), and otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::SetTV1().

◆ m_TV2

template<class TInput , class TOutput >
PrecisionType otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::m_TV2
protected

Tolerance value 2

Definition at line 1176 of file otbLandsatTMIndices.h.

Referenced by otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::GetTV2(), otb::Functor::LandsatTM::SpectralRuleBasedClassifier< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::SnowOrIceSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::PitbogOrGreenhouseSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::VegetationSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::RangelandSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::BarrenLandOrBuiltUpOrCloudsSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::FlatResponseBarrenLandOrBuiltUpSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::ShadowWithVegetationSpectralRule< TInput, TOutput >::operator()(), otb::Functor::LandsatTM::WetlandSpectralRule< TInput, TOutput >::operator()(), and otb::Functor::LandsatTM::KernelSpectralRule< TInput, TOutput >::SetTV2().

The documentation for this class was generated from the following file:
Generated at Wed Feb 28 2024 15:25:54 for OTB with   doxygen 1.8.17