ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected 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 >:

Public Types

using ChannelType = std::vector< RealType >
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RealType = typename Superclass::RealType
 
using RGBPixelType = typename Superclass::RGBPixelType
 
using ScalarType = typename Superclass::ScalarType
 
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

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

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

ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/ImageFunction/ResampleSegmentedImage/Code.cxx, SphinxExamples/src/Filtering/Colormap/CreateACustomColormap/Code.cxx, and SphinxExamples/src/Segmentation/ConnectedComponents/AssignContiguousLabelsToConnectedRegions/Code.cxx.

Definition at line 50 of file itkCustomColormapFunction.h.

Member Typedef Documentation

◆ ChannelType

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

Definition at line 67 of file itkCustomColormapFunction.h.

◆ ConstPointer

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

Definition at line 58 of file itkCustomColormapFunction.h.

◆ Pointer

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

Definition at line 57 of file itkCustomColormapFunction.h.

◆ RealType

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

Definition at line 65 of file itkCustomColormapFunction.h.

◆ RGBPixelType

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

Definition at line 63 of file itkCustomColormapFunction.h.

◆ ScalarType

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

Definition at line 64 of file itkCustomColormapFunction.h.

◆ Self

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

Definition at line 55 of file itkCustomColormapFunction.h.

◆ Superclass

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

Definition at line 56 of file itkCustomColormapFunction.h.

Constructor & Destructor Documentation

◆ CustomColormapFunction()

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

◆ ~CustomColormapFunction()

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

Member Function Documentation

◆ CreateAnother()

template<typename TScalar , typename TRGBPixel >
virtual::itk::LightObject::Pointer itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::CreateAnother ( ) 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.

◆ GetBlueChannel()

template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::GetBlueChannel ( ) const
inline

Definition at line 103 of file itkCustomColormapFunction.h.

◆ GetGreenChannel()

template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::GetGreenChannel ( ) const
inline

Definition at line 91 of file itkCustomColormapFunction.h.

◆ GetRedChannel()

template<typename TScalar , typename TRGBPixel >
ChannelType itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::GetRedChannel ( ) const
inline

Definition at line 79 of file itkCustomColormapFunction.h.

◆ New()

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

Method for creation through the object factory.

◆ operator()()

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

◆ SetBlueChannel()

template<typename TScalar , typename TRGBPixel >
void itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::SetBlueChannel ( ChannelType  blue)
inline

Definition at line 97 of file itkCustomColormapFunction.h.

◆ SetGreenChannel()

template<typename TScalar , typename TRGBPixel >
void itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::SetGreenChannel ( ChannelType  green)
inline

Definition at line 85 of file itkCustomColormapFunction.h.

◆ SetRedChannel()

template<typename TScalar , typename TRGBPixel >
void itk::Function::CustomColormapFunction< TScalar, TRGBPixel >::SetRedChannel ( ChannelType  red)
inline

Definition at line 73 of file itkCustomColormapFunction.h.

Member Data Documentation

◆ m_BlueChannel

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

Definition at line 115 of file itkCustomColormapFunction.h.

◆ m_GreenChannel

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

Definition at line 114 of file itkCustomColormapFunction.h.

◆ m_RedChannel

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

Definition at line 113 of file itkCustomColormapFunction.h.


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