itk::Functor::ScalarToRGBPixelFunctor< TScalar > Class Template Reference

#include <itkScalarToRGBPixelFunctor.h>

Detailed Description

template<typename TScalar>
class itk::Functor::ScalarToRGBPixelFunctor< TScalar >

A Function object which maps a scalar value into an RGB pixel value.

This class is useful for visualizing labeled images which cannot be mapped successfully into grayscale images. Images of unsigned long integers, for example, may have too many graylevels to visualize effectively.

The hashing scheme used is designed to spread close scalar values of very different colors by using the least significant bits (fastest changing) of the scalar type to determine the color. Because labeled images may typically use sequential values, it is desirable that those values result in easily discernible colors.

Examples

Examples/Segmentation/WatershedSegmentation1.cxx, and Examples/Segmentation/WatershedSegmentation2.cxx.

Definition at line 42 of file itkScalarToRGBPixelFunctor.h.

Public Types
using	RGBComponentType = unsigned char
using	RGBPixelType = RGBPixel<RGBComponentType>
using	ScalarType = TScalar

Public Member Functions
bool	GetUseMSBForHashing () const
RGBPixelType	operator() (const TScalar &) const
	ScalarToRGBPixelFunctor ()
void	SetBigEndian ()
void	SetLittleEndian ()
void	SetUseMSBForHashing (bool value)
void	UseMSBForHashingOff ()
void	UseMSBForHashingOn ()
	~ScalarToRGBPixelFunctor ()=default

Private Attributes
unsigned int	m_ColorIndex [3]
bool	m_UseMSBForHashing

Member Typedef Documentation

RGBComponentType

template<typename TScalar>

using itk::Functor::ScalarToRGBPixelFunctor< TScalar >::RGBComponentType = unsigned char

Definition at line 48 of file itkScalarToRGBPixelFunctor.h.

RGBPixelType

template<typename TScalar>

using itk::Functor::ScalarToRGBPixelFunctor< TScalar >::RGBPixelType = RGBPixel<RGBComponentType>

Definition at line 49 of file itkScalarToRGBPixelFunctor.h.

ScalarType

template<typename TScalar>

using itk::Functor::ScalarToRGBPixelFunctor< TScalar >::ScalarType = TScalar

Definition at line 50 of file itkScalarToRGBPixelFunctor.h.

Constructor & Destructor Documentation

ScalarToRGBPixelFunctor()

template<typename TScalar>

itk::Functor::ScalarToRGBPixelFunctor< TScalar >::ScalarToRGBPixelFunctor

(

)

~ScalarToRGBPixelFunctor()

template<typename TScalar>

itk::Functor::ScalarToRGBPixelFunctor< TScalar >::~ScalarToRGBPixelFunctor ( )

default

Member Function Documentation

GetUseMSBForHashing()

template<typename TScalar>

bool itk::Functor::ScalarToRGBPixelFunctor< TScalar >::GetUseMSBForHashing ( ) const

inlinenodiscard

Definition at line 74 of file itkScalarToRGBPixelFunctor.h.

References m_UseMSBForHashing.

operator()()

template<typename TScalar>

RGBPixelType itk::Functor::ScalarToRGBPixelFunctor< TScalar >::operator()

(

const TScalar &

)

const

SetBigEndian()

template<typename TScalar>

void itk::Functor::ScalarToRGBPixelFunctor< TScalar >::SetBigEndian ( )

inline

Definition at line 62 of file itkScalarToRGBPixelFunctor.h.

References m_UseMSBForHashing.

SetLittleEndian()

template<typename TScalar>

void itk::Functor::ScalarToRGBPixelFunctor< TScalar >::SetLittleEndian ( )

inline

Definition at line 56 of file itkScalarToRGBPixelFunctor.h.

References m_UseMSBForHashing.

SetUseMSBForHashing()

template<typename TScalar>

void itk::Functor::ScalarToRGBPixelFunctor< TScalar >::SetUseMSBForHashing ( bool value )

inline

Definition at line 68 of file itkScalarToRGBPixelFunctor.h.

References m_UseMSBForHashing.

UseMSBForHashingOff()

template<typename TScalar>

void itk::Functor::ScalarToRGBPixelFunctor< TScalar >::UseMSBForHashingOff ( )

inline

Definition at line 86 of file itkScalarToRGBPixelFunctor.h.

References m_UseMSBForHashing.

UseMSBForHashingOn()

template<typename TScalar>

void itk::Functor::ScalarToRGBPixelFunctor< TScalar >::UseMSBForHashingOn ( )

inline

Definition at line 80 of file itkScalarToRGBPixelFunctor.h.

References m_UseMSBForHashing.

Member Data Documentation

m_ColorIndex

template<typename TScalar>

unsigned int itk::Functor::ScalarToRGBPixelFunctor< TScalar >::m_ColorIndex[3]

private

Definition at line 94 of file itkScalarToRGBPixelFunctor.h.

m_UseMSBForHashing

template<typename TScalar>

bool itk::Functor::ScalarToRGBPixelFunctor< TScalar >::m_UseMSBForHashing

private

Definition at line 93 of file itkScalarToRGBPixelFunctor.h.

Referenced by GetUseMSBForHashing(), SetBigEndian(), SetLittleEndian(), SetUseMSBForHashing(), UseMSBForHashingOff(), and UseMSBForHashingOn().

---

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

• itkScalarToRGBPixelFunctor.h