ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Function::ColormapFunction< TScalar, TRGBPixel > Class Template Referenceabstract

#include <itkColormapFunction.h>

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

Detailed Description

template<typename TScalar, typename 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 https://hdl.handle.net/1926/1452

Definition at line 46 of file itkColormapFunction.h.

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

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 override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- 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
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 

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 ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 53 of file itkColormapFunction.h.

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

Definition at line 52 of file itkColormapFunction.h.

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

Definition at line 61 of file itkColormapFunction.h.

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

Definition at line 59 of file itkColormapFunction.h.

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

Definition at line 56 of file itkColormapFunction.h.

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

Definition at line 60 of file itkColormapFunction.h.

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

Definition at line 50 of file itkColormapFunction.h.

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

Definition at line 51 of file itkColormapFunction.h.

Constructor & Destructor Documentation

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

Definition at line 96 of file itkColormapFunction.h.

Member Function Documentation

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

Definition at line 75 of file itkColormapFunction.h.

template<typename TScalar , typename TRGBPixel >
virtual RGBPixelType itk::Function::ColormapFunction< TScalar, TRGBPixel >::operator() ( const ScalarType &  ) const
pure virtual
template<typename TScalar , typename 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<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual
template<typename TScalar , typename TRGBPixel >
RealType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleInputValue ( ScalarType  v) const
inlineprotected
template<typename TScalar , typename TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleRGBComponentValue ( RealType  v) const
inlineprotected
template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMaximumInputValue ( ScalarType  _arg)
virtual
template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMaximumRGBComponentValue ( RGBComponentType  _arg)
virtual
template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMinimumInputValue ( ScalarType  _arg)
virtual
template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMinimumRGBComponentValue ( RGBComponentType  _arg)
virtual

Member Data Documentation

template<typename TScalar , typename TRGBPixel >
ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumInputValue
private
template<typename TScalar , typename TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumRGBComponentValue
private
template<typename TScalar , typename TRGBPixel >
ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumInputValue
private
template<typename TScalar , typename TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumRGBComponentValue
private

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