OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel > Class Template Reference

#include <otbScalarToRainbowRGBPixelFunctor.h>

+ Inheritance diagram for otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >:
+ Collaboration diagram for otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef HSVToRGBFunctor
< RGBPixelType
HSVToRGBFunctorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef RGBPixelType::ComponentType RGBComponentType
 
typedef TRGBPixel RGBPixelType
 
typedef TScalar ScalarType
 
typedef
ScalarToRainbowRGBPixelFunctor 
Self
 
typedef
itk::Function::ColormapFunction
< TScalar, TRGBPixel > 
Superclass
 
- Public Types inherited from itk::Function::ColormapFunction< TScalar, TRGBPixel >
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef NumericTraits
< ScalarType >::RealType 
RealType
 
typedef TRGBPixel::ComponentType RGBComponentType
 
typedef TRGBPixel RGBPixelType
 
typedef TScalar ScalarType
 
typedef ColormapFunction Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
RGBPixelType operator() (const TScalar &) const override
 
 ScalarToRainbowRGBPixelFunctor ()
 
 ~ScalarToRainbowRGBPixelFunctor () override
 
- Public Member Functions inherited from itk::Function::ColormapFunction< TScalar, TRGBPixel >
virtual ScalarType GetMaximumInputValue () const
 
virtual RGBComponentType GetMaximumRGBComponentValue () const
 
virtual ScalarType GetMinimumInputValue () const
 
virtual RGBComponentType GetMinimumRGBComponentValue () const
 
virtual const char * GetNameOfClass () const
 
virtual bool operator!= (const ColormapFunction &) const
 
virtual bool operator== (const ColormapFunction &other) const
 
virtual void SetMaximumInputValue (ScalarType _arg)
 
virtual void SetMaximumRGBComponentValue (RGBComponentType _arg)
 
virtual void SetMinimumInputValue (ScalarType _arg)
 
virtual void SetMinimumRGBComponentValue (RGBComponentType _arg)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

RGBPixelType HSVToRGB (double h, double s, double v) const
 
- Protected Member Functions inherited from itk::Function::ColormapFunction< TScalar, TRGBPixel >
 ColormapFunction ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
RealType RescaleInputValue (ScalarType v) const
 
RGBComponentType RescaleRGBComponentValue (RealType v) const
 
 ~ColormapFunction ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

HSVToRGBFunctorType m_HSVToRGBFunctor
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
class otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >

Function object which maps a scalar value into a rainbow RGB pixel value.

Grayscale image is mapped to a color image where blue represents small values and red represents big values.

This function is compatible with the colormap hierarchy presented in http://hdl.handle.net/1926/1452

Examples:
BasicFilters/DEMToRainbowExample.cxx.

Definition at line 137 of file otbScalarToRainbowRGBPixelFunctor.h.

Member Typedef Documentation

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef itk::SmartPointer<const Self> otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::ConstPointer

Definition at line 148 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef HSVToRGBFunctor<RGBPixelType> otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::HSVToRGBFunctorType

Definition at line 156 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef itk::SmartPointer<Self> otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::Pointer

Definition at line 147 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef RGBPixelType::ComponentType otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::RGBComponentType

Definition at line 154 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef TRGBPixel otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::RGBPixelType

Definition at line 151 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef TScalar otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::ScalarType

Definition at line 155 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef ScalarToRainbowRGBPixelFunctor otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::Self

Definition at line 145 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
typedef itk::Function::ColormapFunction<TScalar, TRGBPixel> otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::Superclass

Definition at line 146 of file otbScalarToRainbowRGBPixelFunctor.h.

Constructor & Destructor Documentation

template<class TScalar , class TRGBPixel >
otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::ScalarToRainbowRGBPixelFunctor ( )

Definition at line 35 of file otbScalarToRainbowRGBPixelFunctor.hxx.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::~ScalarToRainbowRGBPixelFunctor ( )
inlineoverride

Definition at line 143 of file otbScalarToRainbowRGBPixelFunctor.h.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::ScalarToRainbowRGBPixelFunctor ( const Self )
privatedelete

Member Function Documentation

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
virtual::itk::LightObject::Pointer otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
RGBPixelType otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::HSVToRGB ( double  h,
double  s,
double  v 
) const
protected
template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
static Pointer otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::New ( )
static

Method for creation through the object factory.

template<class TScalar, class TRGBPixel >
ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::RGBPixelType otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::operator() ( const TScalar &  v) const
overridevirtual
template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
void otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::operator= ( const Self )
privatedelete

Member Data Documentation

template<class TScalar, class TRGBPixel = itk::RGBPixel<unsigned char>>
HSVToRGBFunctorType otb::Functor::ScalarToRainbowRGBPixelFunctor< TScalar, TRGBPixel >::m_HSVToRGBFunctor
private

Definition at line 167 of file otbScalarToRainbowRGBPixelFunctor.h.


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