OTB  6.7.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>

+ Inheritance diagram for otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >:

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 73 of file otbHillShadingFunctor.h.

Member Typedef Documentation

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

Definition at line 78 of file otbHillShadingFunctor.h.

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

Definition at line 79 of file otbHillShadingFunctor.h.

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

Definition at line 77 of file otbHillShadingFunctor.h.

Constructor & Destructor Documentation

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

Definition at line 81 of file otbHillShadingFunctor.h.

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

Definition at line 89 of file otbHillShadingFunctor.h.

Member Function Documentation

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

Definition at line 121 of file otbHillShadingFunctor.h.

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

Definition at line 133 of file otbHillShadingFunctor.h.

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

Definition at line 111 of file otbHillShadingFunctor.h.

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

Definition at line 91 of file otbHillShadingFunctor.h.

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

Definition at line 96 of file otbHillShadingFunctor.h.

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

Definition at line 145 of file otbHillShadingFunctor.h.

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

Definition at line 126 of file otbHillShadingFunctor.h.

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

Definition at line 138 of file otbHillShadingFunctor.h.

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

Definition at line 116 of file otbHillShadingFunctor.h.

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

Definition at line 101 of file otbHillShadingFunctor.h.

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

Definition at line 106 of file otbHillShadingFunctor.h.

Member Data Documentation

template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_AzimuthLight
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosAz
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_CosElev
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_ElevationLight
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_Scale
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinAz
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_SinElev
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_XRes
private
template<class TNeighIter, class TInputImage, class TOutput>
double otb::Functor::HillShadingFunctor< TNeighIter, TInputImage, TOutput >::m_YRes
private

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