#include <itkCustomColormapFunction.h>

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" https://doi.org/10.54294/tmojbk

ITK Sphinx Examples:

All ITK Sphinx Examples

Create A Custom Colormap

Apply A Colormap To An Image

Examples: SphinxExamples/src/Filtering/Colormap/CreateACustomColormap/Code.cxx, and SphinxExamples/src/Segmentation/ConnectedComponents/AssignContiguousLabelsToConnectedRegions/Code.cxx.

Definition at line 49 of file itkCustomColormapFunction.h.

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

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

Public Types
using	ChannelType = std::vector< RealType >

using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = CustomColormapFunction

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
ChannelType	GetBlueChannel () const

ChannelType	GetGreenChannel () const

ChannelType	GetRedChannel () const

RGBPixelType	operator() (const TScalar &) const override

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

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 *cmd) 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

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

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
	CustomColormapFunction ()=default

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

Private Attributes
ChannelType	m_BlueChannel {}

ChannelType	m_GreenChannel {}

ChannelType	m_RedChannel {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}