otb::Functor::RenderingFunctor< TPixel, TRGBPixel > Class Template Reference

This functor renders the input pixel. This functor renders the input pixel to a printable format (unsigned char RGB). It uses a rendering function which is in charge of the rendering. More...

#include <otbRenderingImageFilter.h>

Inheritance diagram for otb::Functor::RenderingFunctor< TPixel, TRGBPixel >:

Collaboration diagram for otb::Functor::RenderingFunctor< TPixel, TRGBPixel >:

List of all members.

Public Types
typedef itk::MetaDataDictionary	MetaDataDictionaryType
typedef TPixel	PixelType
typedef RenderingFunctionType::Pointer	RenderingFunctionPointerType
typedef otb::Function::RenderingFunction < TPixel, TRGBPixel >	RenderingFunctionType
typedef itk::RGBAPixel < ScalarPixelType >	RGBAPixelType
typedef itk::RGBPixel < ScalarPixelType >	RGBPixelType
typedef itk::NumericTraits < PixelType >::ValueType	ScalarPixelType
typedef itk::VariableLengthVector < ScalarPixelType >	VectorPixelType

Public Member Functions
	RenderingFunctor ()
virtual	~RenderingFunctor ()
RenderingFunctionType *	GetFunction (void)
void	InitializeFunction (const MetaDataDictionaryType &metadatadictionary)
TRGBPixel	operator() (const PixelType &pixel) const
void	SetFunction (RenderingFunctionType *function)

Private Attributes
RenderingFunctionPointerType	m_Function

---

Detailed Description

template<class TPixel, class TRGBPixel>
class otb::Functor::RenderingFunctor< TPixel, TRGBPixel >

This functor renders the input pixel. This functor renders the input pixel to a printable format (unsigned char RGB). It uses a rendering function which is in charge of the rendering.

It defines both operators on scalar and vector pixels, so it can be used either on VectorImage or Image.

The operators call the Evaluate() method of the rendering function and returns its result.

See also:

ImageLayer

RenderingImageFilter

RenderingFunction

Definition at line 52 of file otbRenderingImageFilter.h.

---

Member Typedef Documentation

template<class TPixel, class TRGBPixel>

typedef itk::MetaDataDictionary otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::MetaDataDictionaryType

Definition at line 66 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

typedef TPixel otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::PixelType

Default rendering function typedef

Definition at line 60 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

typedef RenderingFunctionType::Pointer otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::RenderingFunctionPointerType

Rendering function pointer typedef

Definition at line 58 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

typedef otb::Function::RenderingFunction<TPixel, TRGBPixel> otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::RenderingFunctionType

Rendering function typedef

Definition at line 56 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

typedef itk::RGBAPixel<ScalarPixelType> otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::RGBAPixelType

Definition at line 64 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

typedef itk::RGBPixel<ScalarPixelType> otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::RGBPixelType

Definition at line 63 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

typedef itk::NumericTraits<PixelType>::ValueType otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::ScalarPixelType

Definition at line 61 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

typedef itk::VariableLengthVector<ScalarPixelType> otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::VectorPixelType

Definition at line 62 of file otbRenderingImageFilter.h.

---

Constructor & Destructor Documentation

template<class TPixel, class TRGBPixel>

otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::RenderingFunctor ( )

inline

Constructor

Definition at line 75 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

virtual otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::~RenderingFunctor ( )

inlinevirtual

Destructor

Definition at line 82 of file otbRenderingImageFilter.h.

---

Member Function Documentation

template<class TPixel, class TRGBPixel>

RenderingFunctionType* otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::GetFunction ( void  )

inline

Get the rendering function

Returns:

the Rendering function.

Definition at line 95 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

void otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::InitializeFunction ( const MetaDataDictionaryType &  metadatadictionary )

inline

Initialize the rendering function.

Definition at line 103 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

TRGBPixel otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::operator() ( const PixelType &  pixel ) const

inline

Pixel operator

Definition at line 69 of file otbRenderingImageFilter.h.

template<class TPixel, class TRGBPixel>

void otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::SetFunction ( RenderingFunctionType *  function )

inline

Set the rendering function

Parameters:

function

the Rendering function.

Definition at line 87 of file otbRenderingImageFilter.h.

---

Member Data Documentation

template<class TPixel, class TRGBPixel>

RenderingFunctionPointerType otb::Functor::RenderingFunctor< TPixel, TRGBPixel >::m_Function

private

The rendering function

Definition at line 110 of file otbRenderingImageFilter.h.

Referenced by otb::Functor::RenderingFunctor< TInputImage::PixelType, TOutputImage::PixelType >::GetFunction(), otb::Functor::RenderingFunctor< TInputImage::PixelType, TOutputImage::PixelType >::InitializeFunction(), otb::Functor::RenderingFunctor< TInputImage::PixelType, TOutputImage::PixelType >::operator()(), and otb::Functor::RenderingFunctor< TInputImage::PixelType, TOutputImage::PixelType >::SetFunction().

---

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

• otbRenderingImageFilter.h