ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::Function::CoolColormapFunction< TScalar, TRGBPixel > Class Template Reference

#include <itkCoolColormapFunction.h>

Detailed Description

template<typename TScalar, typename TRGBPixel>
class itk::Function::CoolColormapFunction< 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
Cool colormap.

This code was contributed in the Insight Journal paper:

"Meeting Andy Warhol Somewhere Over the Rainbow: RGB Colormapping and ITK" https://www.insight-journal.org/browse/publication/285

Definition at line 43 of file itkCoolColormapFunction.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = CoolColormapFunction
 
using Superclass = ColormapFunction< TScalar, TRGBPixel >
 
- Public Types inherited from itk::Function::ColormapFunction< TScalar, TRGBPixel >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< ScalarType >::RealType
 
using RGBComponentType = typename TRGBPixel::ComponentType
 
using RGBPixelType = TRGBPixel
 
using ScalarType = TScalar
 
using Self = ColormapFunction
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

RGBPixelType operator() (const TScalar &) const 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
 
const char * GetNameOfClass () const override
 
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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 CoolColormapFunction ()=default
 
 ~CoolColormapFunction () override=default
 
- Protected Member Functions inherited from itk::Function::ColormapFunction< TScalar, TRGBPixel >
 ColormapFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ColormapFunction () override=default
 
RealType RescaleInputValue (ScalarType v) const
 
RGBComponentType RescaleRGBComponentValue (RealType v) const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 ()
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar , typename TRGBPixel >
using itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::ConstPointer = SmartPointer<const Self>

Definition at line 51 of file itkCoolColormapFunction.h.

◆ Pointer

template<typename TScalar , typename TRGBPixel >
using itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::Pointer = SmartPointer<Self>

Definition at line 50 of file itkCoolColormapFunction.h.

◆ Self

template<typename TScalar , typename TRGBPixel >
using itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::Self = CoolColormapFunction

Definition at line 48 of file itkCoolColormapFunction.h.

◆ Superclass

template<typename TScalar , typename TRGBPixel >
using itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::Superclass = ColormapFunction<TScalar, TRGBPixel>

Definition at line 49 of file itkCoolColormapFunction.h.

Constructor & Destructor Documentation

◆ CoolColormapFunction()

template<typename TScalar , typename TRGBPixel >
itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::CoolColormapFunction ( )
protecteddefault

◆ ~CoolColormapFunction()

template<typename TScalar , typename TRGBPixel >
itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::~CoolColormapFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

template<typename TScalar , typename TRGBPixel >
static Pointer itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::New ( )
static

Method for creation through the object factory.

◆ operator()()

template<typename TScalar , typename TRGBPixel >
RGBPixelType itk::Function::CoolColormapFunction< TScalar, TRGBPixel >::operator() ( const TScalar &  ) const
overridevirtual

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