ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Function::CustomColormapFunction< TScalar, TRGBPixel > Class Template Reference

#include <itkCustomColormapFunction.h>

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

Detailed Description

template<typename TScalar, typename TRGBPixel>
class itk::Function::CustomColormapFunction< 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 45 of file itkCustomColormapFunction.h.

Public Types

typedef std::vector< RealTypeChannelType
 
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RealType RealType
 
typedef Superclass::RGBPixelType RGBPixelType
 
typedef Superclass::ScalarType ScalarType
 
typedef CustomColormapFunction Self
 
typedef 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
 
ChannelType GetBlueChannel () const
 
ChannelType GetGreenChannel () const
 
ChannelType GetRedChannel () const
 
virtual RGBPixelType operator() (const TScalar &) const
 
void SetBlueChannel (ChannelType blue)
 
void SetGreenChannel (ChannelType green)
 
void SetRedChannel (ChannelType red)
 
- 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
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () 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 ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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
 

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

 CustomColormapFunction ()
 
 ~CustomColormapFunction ()
 
- Protected Member Functions inherited from itk::Function::ColormapFunction< TScalar, TRGBPixel >
 ColormapFunction ()
 
 ~ColormapFunction ()
 
RealType RescaleInputValue (ScalarType v) const
 
RGBComponentType RescaleRGBComponentValue (RealType v) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_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 ()
 
- 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

 CustomColormapFunction (const Self &)
 
void operator= (const Self &)
 

Private Attributes

ChannelType m_BlueChannel
 
ChannelType m_GreenChannel
 
ChannelType m_RedChannel
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

template<typename TScalar , typename TRGBPixel >
typedef std::vector< RealType > itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::ChannelType

Definition at line 62 of file itkCustomColormapFunction.h.

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

Definition at line 53 of file itkCustomColormapFunction.h.

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

Definition at line 52 of file itkCustomColormapFunction.h.

template<typename TScalar , typename TRGBPixel >
typedef Superclass::RealType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::RealType

Definition at line 60 of file itkCustomColormapFunction.h.

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

Definition at line 56 of file itkCustomColormapFunction.h.

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

Definition at line 59 of file itkCustomColormapFunction.h.

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

Definition at line 50 of file itkCustomColormapFunction.h.

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

Definition at line 51 of file itkCustomColormapFunction.h.

Constructor & Destructor Documentation

template<typename TScalar , typename TRGBPixel >
itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::CustomColormapFunction ( )
inlineprotected

Definition at line 97 of file itkCustomColormapFunction.h.

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

Definition at line 98 of file itkCustomColormapFunction.h.

template<typename TScalar , typename TRGBPixel >
itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::CustomColormapFunction ( const Self )
private

Member Function Documentation

template<typename TScalar , typename TRGBPixel >
virtual::itk::LightObject::Pointer itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::GetBlueChannel ( ) const
inline
template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::GetGreenChannel ( ) const
inline
template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::GetRedChannel ( ) const
inline
template<typename TScalar , typename TRGBPixel >
static Pointer itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::New ( )
static

Method for creation through the object factory.

template<typename TScalar , typename TRGBPixel >
virtual RGBPixelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::operator() ( const TScalar &  ) const
virtual
template<typename TScalar , typename TRGBPixel >
void itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::operator= ( const Self )
private
template<typename TScalar , typename TRGBPixel >
void itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::SetBlueChannel ( ChannelType  blue)
inline
template<typename TScalar , typename TRGBPixel >
void itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::SetGreenChannel ( ChannelType  green)
inline
template<typename TScalar , typename TRGBPixel >
void itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::SetRedChannel ( ChannelType  red)
inline

Member Data Documentation

template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::m_BlueChannel
private
template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::m_GreenChannel
private
template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::m_RedChannel
private

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