ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions
itk::Function::ColormapFunction< TScalar, TRGBPixel > Class Template Reference
Module ITKColormap

#include <itkColormapFunction.h>

+ Inheritance diagram for itk::Function::ColormapFunction< TScalar, TRGBPixel >:
+ Collaboration diagram for itk::Function::ColormapFunction< TScalar, TRGBPixel >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef SmartPointer< Self > Pointer
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
- Public Types inherited from itk::LightObject

Public Member Functions

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 RGBPixelType operator() (const ScalarType &) const =0
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 LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStamp & GetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- 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

Protected Member Functions

 ColormapFunction ()
 ~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 ()
ScalarType m_MinimumInputValue
ScalarType m_MaximumInputValue
RGBComponentType m_MinimumRGBComponentValue
RGBComponentType m_MaximumRGBComponentValue
RealType RescaleInputValue (ScalarType v) const
RGBComponentType RescaleRGBComponentValue (RealType v) const
void PrintSelf (std::ostream &os, Indent indent) const
 ColormapFunction (const Self &)
void operator= (const Self &)

Additional Inherited Members

- 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 ()

Detailed Description

template<class TScalar, class TRGBPixel>
class itk::Function::ColormapFunction< TScalar, TRGBPixel >

Function object which maps a scalar value into an RGB colormap value.

Author:
Nicholas Tustison, Hui Zhang, Gaetan Lehmann, Paul Yushkevich and James C. Gee

This code was contributed in the Insight Journal paper:

"Meeting Andy Warhol Somewhere Over the Rainbow: RGB Colormapping and ITK" http://www.insight-journal.org/browse/publication/285 http://hdl.handle.net/1926/1452

Definition at line 46 of file itkColormapFunction.h.

Member Typedef Documentation

template<class TScalar , class TRGBPixel >
typedef SmartPointer< const Self > itk::Function::ColormapFunction< TScalar, TRGBPixel >::ConstPointer

Reimplemented from itk::Object.

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

Definition at line 53 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
typedef SmartPointer< Self > itk::Function::ColormapFunction< TScalar, TRGBPixel >::Pointer

Reimplemented from itk::Object.

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

Definition at line 52 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
typedef NumericTraits< ScalarType >::RealType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RealType

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

Definition at line 61 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
typedef TRGBPixel::ComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RGBComponentType

Definition at line 59 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
typedef TRGBPixel itk::Function::ColormapFunction< TScalar, TRGBPixel >::RGBPixelType

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

Definition at line 56 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
typedef TScalar itk::Function::ColormapFunction< TScalar, TRGBPixel >::ScalarType

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

Definition at line 60 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
typedef ColormapFunction itk::Function::ColormapFunction< TScalar, TRGBPixel >::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

Definition at line 50 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
typedef Object itk::Function::ColormapFunction< TScalar, TRGBPixel >::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

Definition at line 51 of file itkColormapFunction.h.

Constructor & Destructor Documentation

template<class TScalar , class TRGBPixel >
itk::Function::ColormapFunction< TScalar, TRGBPixel >::ColormapFunction ( )
inlineprotected

Definition at line 88 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
itk::Function::ColormapFunction< TScalar, TRGBPixel >::~ColormapFunction ( )
inlineprotected

Definition at line 96 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
itk::Function::ColormapFunction< TScalar, TRGBPixel >::ColormapFunction ( const Self &  )
private

Map [min, max] input values to [0, 1].

Member Function Documentation

template<class TScalar , class TRGBPixel >
virtual ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMaximumInputValue ( ) const
virtual
template<class TScalar , class TRGBPixel >
virtual RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMaximumRGBComponentValue ( ) const
virtual
template<class TScalar , class TRGBPixel >
virtual ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMinimumInputValue ( ) const
virtual
template<class TScalar , class TRGBPixel >
virtual RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMinimumRGBComponentValue ( ) const
virtual
template<class TScalar , class TRGBPixel >
virtual const char* itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<class TScalar , class TRGBPixel >
virtual bool itk::Function::ColormapFunction< TScalar, TRGBPixel >::operator!= ( const ColormapFunction< TScalar, TRGBPixel > &  ) const
inlinevirtual

Definition at line 75 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
virtual RGBPixelType itk::Function::ColormapFunction< TScalar, TRGBPixel >::operator() ( const ScalarType &  ) const
pure virtual

Implemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

template<class TScalar , class TRGBPixel >
void itk::Function::ColormapFunction< TScalar, TRGBPixel >::operator= ( const Self &  )
private

Map [min, max] input values to [0, 1].

Reimplemented from itk::Object.

Reimplemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

template<class TScalar , class TRGBPixel >
virtual bool itk::Function::ColormapFunction< TScalar, TRGBPixel >::operator== ( const ColormapFunction< TScalar, TRGBPixel > &  other) const
inlinevirtual

Definition at line 80 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
void itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineprotectedvirtual

Map [min, max] input values to [0, 1].

Reimplemented from itk::Object.

Definition at line 128 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
RealType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleInputValue ( ScalarType  v) const
inlineprotected

Map [min, max] input values to [0, 1].

Definition at line 101 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleRGBComponentValue ( RealType  v) const
inlineprotected

Map [0, 1] value to [min, max] rgb component values.

Definition at line 117 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMaximumInputValue ( ScalarType  _arg)
virtual
template<class TScalar , class TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMaximumRGBComponentValue ( RGBComponentType  _arg)
virtual
template<class TScalar , class TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMinimumInputValue ( ScalarType  _arg)
virtual
template<class TScalar , class TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMinimumRGBComponentValue ( RGBComponentType  _arg)
virtual

Member Data Documentation

template<class TScalar , class TRGBPixel >
ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumInputValue
private

Map [min, max] input values to [0, 1].

Definition at line 151 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumRGBComponentValue
private

Map [min, max] input values to [0, 1].

Definition at line 154 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumInputValue
private

Map [min, max] input values to [0, 1].

Definition at line 150 of file itkColormapFunction.h.

template<class TScalar , class TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumRGBComponentValue
private

Map [min, max] input values to [0, 1].

Definition at line 153 of file itkColormapFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Wed Jul 11 2012 00:32:50 for ITK by doxygen 1.8.1