itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel > Class Template Reference

#include <itkLabelOverlayFunctor.h>

Detailed Description

template<typename TInputPixel, typename TLabel, typename TRGBPixel>
class itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >

Functor for applying a colormap to a label image and combine it with a grayscale image.

This functor class used internally by LabelOverlayImageFilter

This code was contributed in the Insight Journal paper: "The watershed transform in ITK - discussion and new developments" by Beare R., Lehmann G. https://doi.org/10.54294/lf8u75

Author

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also

LabelOverlayImageFilter LabelToRGBFunctor

Definition at line 48 of file itkLabelOverlayFunctor.h.

Public Types
using	ComponentType = typename TRGBPixel::ComponentType

Public Member Functions
void	AddColor (unsigned char r, unsigned char g, unsigned char b)
unsigned int	GetNumberOfColors () const
	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (LabelOverlayFunctor)
	LabelOverlayFunctor ()
TRGBPixel	operator() (const TInputPixel &p1, const TLabel &p2) const
bool	operator== (const LabelOverlayFunctor &other) const
void	ResetColors ()
void	SetBackgroundValue (TLabel v)
void	SetOpacity (double opacity)
	~LabelOverlayFunctor ()=default

Private Attributes
TLabel	m_BackgroundValue
double	m_Opacity
Functor::LabelToRGBFunctor< TLabel, TRGBPixel >	m_RGBFunctor

Member Typedef Documentation

ComponentType

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

using itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::ComponentType = typename TRGBPixel::ComponentType

type of the color component

Definition at line 128 of file itkLabelOverlayFunctor.h.

Constructor & Destructor Documentation

LabelOverlayFunctor()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::LabelOverlayFunctor ( )

inline

Definition at line 51 of file itkLabelOverlayFunctor.h.

References itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_BackgroundValue, and itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_Opacity.

~LabelOverlayFunctor()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::~LabelOverlayFunctor ( )

default

Member Function Documentation

AddColor()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

void itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::AddColor ( unsigned char  r, unsigned char  g, unsigned char  b  )

inline

Definition at line 131 of file itkLabelOverlayFunctor.h.

References itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_RGBFunctor.

GetNumberOfColors()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

unsigned int itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::GetNumberOfColors ( ) const

inline

Definition at line 122 of file itkLabelOverlayFunctor.h.

References itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_RGBFunctor.

ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION

(

LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >

)

operator()()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

TRGBPixel itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator() ( const TInputPixel &  p1, const TLabel &  p2  ) const

inline

Definition at line 62 of file itkLabelOverlayFunctor.h.

References itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_BackgroundValue, itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_Opacity, itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_RGBFunctor, and itk::NumericTraits< T >::SetLength().

operator==()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

bool itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator== ( const LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel > &  other ) const

inline

Definition at line 92 of file itkLabelOverlayFunctor.h.

References itk::Math::ExactlyEquals(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_BackgroundValue, itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_Opacity, and itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_RGBFunctor.

ResetColors()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

void itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::ResetColors ( )

inline

Definition at line 116 of file itkLabelOverlayFunctor.h.

References itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_RGBFunctor.

SetBackgroundValue()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

void itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::SetBackgroundValue ( TLabel  v )

inline

Definition at line 109 of file itkLabelOverlayFunctor.h.

References itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_BackgroundValue, and itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_RGBFunctor.

SetOpacity()

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

void itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::SetOpacity ( double  opacity )

inline

Definition at line 103 of file itkLabelOverlayFunctor.h.

References itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_Opacity.

Member Data Documentation

m_BackgroundValue

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

TLabel itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_BackgroundValue

private

Definition at line 139 of file itkLabelOverlayFunctor.h.

Referenced by itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::LabelOverlayFunctor(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator()(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator==(), and itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::SetBackgroundValue().

m_Opacity

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

double itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_Opacity

private

Definition at line 138 of file itkLabelOverlayFunctor.h.

Referenced by itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::LabelOverlayFunctor(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator()(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator==(), and itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::SetOpacity().

m_RGBFunctor

template<typename TInputPixel , typename TLabel , typename TRGBPixel >

Functor::LabelToRGBFunctor<TLabel, TRGBPixel> itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::m_RGBFunctor

private

Definition at line 141 of file itkLabelOverlayFunctor.h.

Referenced by itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::AddColor(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::GetNumberOfColors(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator()(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::operator==(), itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::ResetColors(), and itk::Functor::LabelOverlayFunctor< TInputPixel, TLabel, TRGBPixel >::SetBackgroundValue().

---

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

• itkLabelOverlayFunctor.h