ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Function::ColormapFunction< TScalar, TRGBPixel > Class Template Referenceabstract
Group Filtering » Module ITKColormap

#include <itkColormapFunction.h>

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

Public Types

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 ScalarType GetMaximumInputValue () const
 
virtual RGBComponentType GetMaximumRGBComponentValue () const
 
virtual ScalarType GetMinimumInputValue () const
 
virtual RGBComponentType GetMinimumRGBComponentValue () const
 
virtual const char * GetNameOfClass () const
 
virtual RGBPixelType operator() (const ScalarType &) const =0
 
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
 
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)
 
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
 
 itkTypeMacroNoParent (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 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

ScalarType m_MaximumInputValue {}
 
RGBComponentType m_MaximumRGBComponentValue {}
 
ScalarType m_MinimumInputValue {}
 
RGBComponentType m_MinimumRGBComponentValue {}
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

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" https://www.insight-journal.org/browse/publication/285

Definition at line 45 of file itkColormapFunction.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 53 of file itkColormapFunction.h.

◆ Pointer

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

Definition at line 52 of file itkColormapFunction.h.

◆ RealType

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

Definition at line 61 of file itkColormapFunction.h.

◆ RGBComponentType

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

Definition at line 59 of file itkColormapFunction.h.

◆ RGBPixelType

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

Definition at line 58 of file itkColormapFunction.h.

◆ ScalarType

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

Definition at line 60 of file itkColormapFunction.h.

◆ Self

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

Definition at line 50 of file itkColormapFunction.h.

◆ Superclass

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

Definition at line 51 of file itkColormapFunction.h.

Constructor & Destructor Documentation

◆ ColormapFunction()

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

Definition at line 79 of file itkColormapFunction.h.

References itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumInputValue, itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumRGBComponentValue, itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumInputValue, itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumRGBComponentValue, itk::NumericTraits< T >::max(), and itk::NumericTraits< T >::min().

◆ ~ColormapFunction()

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

Member Function Documentation

◆ GetMaximumInputValue()

template<typename TScalar , typename TRGBPixel >
virtual ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMaximumInputValue ( ) const
virtual

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf().

◆ GetMaximumRGBComponentValue()

template<typename TScalar , typename TRGBPixel >
virtual RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMaximumRGBComponentValue ( ) const
virtual

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf().

◆ GetMinimumInputValue()

template<typename TScalar , typename TRGBPixel >
virtual ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMinimumInputValue ( ) const
virtual

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf().

◆ GetMinimumRGBComponentValue()

template<typename TScalar , typename TRGBPixel >
virtual RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMinimumRGBComponentValue ( ) const
virtual

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf().

◆ GetNameOfClass()

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.

◆ operator()()

template<typename TScalar , typename TRGBPixel >
virtual RGBPixelType itk::Function::ColormapFunction< TScalar, TRGBPixel >::operator() ( const ScalarType &  ) const
pure virtual

Implemented in itk::Function::CustomColormapFunction< TScalar, TRGBPixel >, itk::Function::JetColormapFunction< TScalar, TRGBPixel >, itk::Function::GreyColormapFunction< TScalar, TRGBPixel >, itk::Function::HotColormapFunction< TScalar, TRGBPixel >, itk::Function::HSVColormapFunction< TScalar, TRGBPixel >, itk::Function::OverUnderColormapFunction< TScalar, TRGBPixel >, itk::Function::RedColormapFunction< TScalar, TRGBPixel >, itk::Function::SpringColormapFunction< TScalar, TRGBPixel >, itk::Function::SummerColormapFunction< TScalar, TRGBPixel >, itk::Function::WinterColormapFunction< TScalar, TRGBPixel >, itk::Function::AutumnColormapFunction< TScalar, TRGBPixel >, itk::Function::BlueColormapFunction< TScalar, TRGBPixel >, itk::Function::CoolColormapFunction< TScalar, TRGBPixel >, itk::Function::CopperColormapFunction< TScalar, TRGBPixel >, and itk::Function::GreenColormapFunction< TScalar, TRGBPixel >.

◆ PrintSelf()

template<typename TScalar , typename TRGBPixel >
void itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

Definition at line 121 of file itkColormapFunction.h.

References itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMaximumInputValue(), itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMaximumRGBComponentValue(), itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMinimumInputValue(), itk::Function::ColormapFunction< TScalar, TRGBPixel >::GetMinimumRGBComponentValue(), and itk::Object::PrintSelf().

◆ RescaleInputValue()

template<typename TScalar , typename TRGBPixel >
RealType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleInputValue ( ScalarType  v) const
inlineprotected

Map [min, max] input values to [0, 1].

Definition at line 93 of file itkColormapFunction.h.

References itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumInputValue, and itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumInputValue.

◆ RescaleRGBComponentValue()

template<typename TScalar , typename TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleRGBComponentValue ( RealType  v) const
inlineprotected

Map [0, 1] value to [min, max] rgb component values.

Definition at line 111 of file itkColormapFunction.h.

References itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumRGBComponentValue, and itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumRGBComponentValue.

◆ SetMaximumInputValue()

template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMaximumInputValue ( ScalarType  _arg)
virtual

◆ SetMaximumRGBComponentValue()

template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMaximumRGBComponentValue ( RGBComponentType  _arg)
virtual

◆ SetMinimumInputValue()

template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMinimumInputValue ( ScalarType  _arg)
virtual

◆ SetMinimumRGBComponentValue()

template<typename TScalar , typename TRGBPixel >
virtual void itk::Function::ColormapFunction< TScalar, TRGBPixel >::SetMinimumRGBComponentValue ( RGBComponentType  _arg)
virtual

Member Data Documentation

◆ m_MaximumInputValue

template<typename TScalar , typename TRGBPixel >
ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumInputValue {}
private

Definition at line 139 of file itkColormapFunction.h.

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::ColormapFunction(), and itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleInputValue().

◆ m_MaximumRGBComponentValue

template<typename TScalar , typename TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MaximumRGBComponentValue {}
private

Definition at line 142 of file itkColormapFunction.h.

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::ColormapFunction(), and itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleRGBComponentValue().

◆ m_MinimumInputValue

template<typename TScalar , typename TRGBPixel >
ScalarType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumInputValue {}
private

Definition at line 138 of file itkColormapFunction.h.

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::ColormapFunction(), and itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleInputValue().

◆ m_MinimumRGBComponentValue

template<typename TScalar , typename TRGBPixel >
RGBComponentType itk::Function::ColormapFunction< TScalar, TRGBPixel >::m_MinimumRGBComponentValue {}
private

Definition at line 141 of file itkColormapFunction.h.

Referenced by itk::Function::ColormapFunction< TScalar, TRGBPixel >::ColormapFunction(), and itk::Function::ColormapFunction< TScalar, TRGBPixel >::RescaleRGBComponentValue().

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16