OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::HillShadingFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbHillShadingFilter.h>

+ Inheritance diagram for otb::HillShadingFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::HillShadingFilter< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef HillShadingFilter Self
 
- Public Types inherited from otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, Functor::HillShadingFunctor< itk::ConstNeighborhoodIterator< TInputImage >, TInputImage, TOutputImage::PixelType > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Functor::HillShadingFunctor< itk::ConstNeighborhoodIterator< TInputImage >, TInputImage, TOutputImage::PixelType > FunctorType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::ConstPointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef Superclass::InputImageType InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef UnaryFunctorNeighborhoodImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 
typedef itk::ConstNeighborhoodIterator< TInputImage > NeighborhoodIteratorType
 
typedef NeighborhoodIteratorType::RadiusType RadiusType
 
typedef unsigned char RadiusSizeType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
double GetAzimuthLight () const
 
double GetElevationLight () const
 
virtual const char * GetNameOfClass () const
 
void SetAzimuthLight (double az)
 
void SetElevationLight (double el)
 
- Public Member Functions inherited from otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, Functor::HillShadingFunctor< itk::ConstNeighborhoodIterator< TInputImage >, TInputImage, TOutputImage::PixelType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual void SetRadius (InputImageSizeType _arg)
 
void SetRadius (unsigned int radius)
 
virtual InputImageSizeType GetRadius ()
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
void SetFunctor (const FunctorType &functor)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, Functor::HillShadingFunctor< itk::ConstNeighborhoodIterator< TInputImage >, TInputImage, TOutputImage::PixelType > >
static Pointer New ()
 

Protected Member Functions

 HillShadingFilter ()
 
 ~HillShadingFilter () override
 
- Protected Member Functions inherited from otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, Functor::HillShadingFunctor< itk::ConstNeighborhoodIterator< TInputImage >, TInputImage, TOutputImage::PixelType > >
 UnaryFunctorNeighborhoodImageFilter ()
 
 ~UnaryFunctorNeighborhoodImageFilter () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void GenerateInputRequestedRegion (void) override
 

Private Member Functions

 HillShadingFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::HillShadingFilter< TInputImage, TOutputImage >

Filter to compute the lambertian of a surface given as an image.

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.

Examples
BasicFilters/HillShadingExample.cxx.

Definition at line 42 of file otbHillShadingFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::HillShadingFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 52 of file otbHillShadingFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<Self> otb::HillShadingFilter< TInputImage, TOutputImage >::Pointer

Definition at line 51 of file otbHillShadingFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >
typedef HillShadingFilter otb::HillShadingFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 49 of file otbHillShadingFilter.h.

Constructor & Destructor Documentation

◆ HillShadingFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::HillShadingFilter< TInputImage, TOutputImage >::HillShadingFilter ( )
inlineprotected

Definition at line 81 of file otbHillShadingFilter.h.

◆ ~HillShadingFilter()

template<class TInputImage , class TOutputImage >
otb::HillShadingFilter< TInputImage, TOutputImage >::~HillShadingFilter ( )
inlineoverrideprotected

Definition at line 84 of file otbHillShadingFilter.h.

◆ HillShadingFilter() [2/2]

template<class TInputImage , class TOutputImage >
otb::HillShadingFilter< TInputImage, TOutputImage >::HillShadingFilter ( const Self )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::HillShadingFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

◆ GetAzimuthLight()

template<class TInputImage , class TOutputImage >
double otb::HillShadingFilter< TInputImage, TOutputImage >::GetAzimuthLight ( ) const
inline

Definition at line 60 of file otbHillShadingFilter.h.

◆ GetElevationLight()

template<class TInputImage , class TOutputImage >
double otb::HillShadingFilter< TInputImage, TOutputImage >::GetElevationLight ( ) const
inline

Definition at line 70 of file otbHillShadingFilter.h.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >
virtual const char* otb::HillShadingFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer otb::HillShadingFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage >
void otb::HillShadingFilter< TInputImage, TOutputImage >::operator= ( const Self )
privatedelete

◆ SetAzimuthLight()

template<class TInputImage , class TOutputImage >
void otb::HillShadingFilter< TInputImage, TOutputImage >::SetAzimuthLight ( double  az)
inline

Definition at line 65 of file otbHillShadingFilter.h.

◆ SetElevationLight()

template<class TInputImage , class TOutputImage >
void otb::HillShadingFilter< TInputImage, TOutputImage >::SetElevationLight ( double  el)
inline

Definition at line 75 of file otbHillShadingFilter.h.


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