OTB  10.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput > Class Template Reference

#include <otbHillShadingFunctor.h>

Public Types

typedef TNeighIter IteratorType
 
typedef IteratorType::PixelType PixelType
 
typedef HillShadingFunctor Self
 

Public Member Functions

double GetAzimuthLight () const
 
double GetElevationLight () const
 
double GetScale () const
 
double GetXRes () const
 
double GetYRes () const
 
 HillShadingFunctor ()
 
TOutput operator() (const TNeighIter &it) const
 
void SetAzimuthLight (double az)
 
void SetElevationLight (double el)
 
void SetScale (double scale)
 
void SetXRes (double res)
 
void SetYRes (double res)
 
 ~HillShadingFunctor ()
 

Private Member Functions

PixelType makeValid (PixelType v) const
 

Private Attributes

double m_AzimuthLight
 
double m_CosAz
 
double m_CosElev
 
double m_ElevationLight
 
double m_Scale
 
double m_SinAz
 
double m_SinElev
 
double m_XRes
 
double m_YRes
 

Detailed Description

template<class TNeighIter, class TInputImage, class TOutput>
class otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >

Unary neighborhood functor to compute the lambertian of a surface.

The light source is assumed to be at a given elevation and azimuth (by default $ \pi/4 $ and $ \pi/6 $ respectively). This is used to generate hill shading representation of relief. The output is a value between 0 and 1.

Definition at line 77 of file otbHillShadingFunctor.h.

Member Typedef Documentation

◆ IteratorType

template<class TNeighIter , class TInputImage , class TOutput >
typedef TNeighIter otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::IteratorType

Definition at line 81 of file otbHillShadingFunctor.h.

◆ PixelType

template<class TNeighIter , class TInputImage , class TOutput >
typedef IteratorType::PixelType otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::PixelType

Definition at line 82 of file otbHillShadingFunctor.h.

◆ Self

template<class TNeighIter , class TInputImage , class TOutput >
typedef HillShadingFunctor otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::Self

Definition at line 80 of file otbHillShadingFunctor.h.

Constructor & Destructor Documentation

◆ HillShadingFunctor()

template<class TNeighIter , class TInputImage , class TOutput >
otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::HillShadingFunctor ( )
inline

Definition at line 84 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_AzimuthLight, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosAz, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosElev, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_ElevationLight, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinAz, and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinElev.

◆ ~HillShadingFunctor()

template<class TNeighIter , class TInputImage , class TOutput >
otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::~HillShadingFunctor ( )
inline

Definition at line 91 of file otbHillShadingFunctor.h.

Member Function Documentation

◆ GetAzimuthLight()

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetAzimuthLight ( ) const
inline

Definition at line 125 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_AzimuthLight.

◆ GetElevationLight()

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetElevationLight ( ) const
inline

Definition at line 137 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_ElevationLight.

◆ GetScale()

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetScale ( ) const
inline

Definition at line 115 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_Scale.

◆ GetXRes()

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetXRes ( ) const
inline

Definition at line 95 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_XRes.

◆ GetYRes()

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetYRes ( ) const
inline

Definition at line 100 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_YRes.

◆ makeValid()

template<class TNeighIter , class TInputImage , class TOutput >
PixelType otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::makeValid ( PixelType  v) const
inlineprivate

Definition at line 176 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()().

◆ operator()()

template<class TNeighIter , class TInputImage , class TOutput >
TOutput otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator() ( const TNeighIter &  it) const
inline

Definition at line 149 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosAz, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosElev, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_Scale, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinAz, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinElev, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_XRes, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_YRes, and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::makeValid().

◆ SetAzimuthLight()

template<class TNeighIter , class TInputImage , class TOutput >
void otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetAzimuthLight ( double  az)
inline

Definition at line 130 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_AzimuthLight, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosAz, and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinAz.

◆ SetElevationLight()

template<class TNeighIter , class TInputImage , class TOutput >
void otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetElevationLight ( double  el)
inline

Definition at line 142 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosElev, otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_ElevationLight, and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinElev.

◆ SetScale()

template<class TNeighIter , class TInputImage , class TOutput >
void otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetScale ( double  scale)
inline

Definition at line 120 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_Scale.

◆ SetXRes()

template<class TNeighIter , class TInputImage , class TOutput >
void otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetXRes ( double  res)
inline

Definition at line 105 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_XRes.

◆ SetYRes()

template<class TNeighIter , class TInputImage , class TOutput >
void otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetYRes ( double  res)
inline

Definition at line 110 of file otbHillShadingFunctor.h.

References otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_YRes.

Member Data Documentation

◆ m_AzimuthLight

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_AzimuthLight
private

Definition at line 181 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetAzimuthLight(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::HillShadingFunctor(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetAzimuthLight().

◆ m_CosAz

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosAz
private

Definition at line 191 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::HillShadingFunctor(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetAzimuthLight().

◆ m_CosElev

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosElev
private

Definition at line 189 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::HillShadingFunctor(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetElevationLight().

◆ m_ElevationLight

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_ElevationLight
private

Definition at line 182 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetElevationLight(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::HillShadingFunctor(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetElevationLight().

◆ m_Scale

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_Scale
private

Definition at line 185 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetScale(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetScale().

◆ m_SinAz

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinAz
private

Definition at line 190 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::HillShadingFunctor(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetAzimuthLight().

◆ m_SinElev

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinElev
private

Definition at line 188 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::HillShadingFunctor(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetElevationLight().

◆ m_XRes

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_XRes
private

Definition at line 183 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetXRes(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetXRes().

◆ m_YRes

template<class TNeighIter , class TInputImage , class TOutput >
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_YRes
private

Definition at line 184 of file otbHillShadingFunctor.h.

Referenced by otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::GetYRes(), otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::operator()(), and otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::SetYRes().

The documentation for this class was generated from the following file:
Generated at Thu Dec 11 2025 13:40:33 for OTB with   doxygen 1.9.1