itk::simple::LabelMapOverlayImageFilter Class Reference

Apply a colormap to a label map and superimpose it on an image. More...

#include <sitkLabelMapOverlayImageFilter.h>

Inheritance diagram for itk::simple::LabelMapOverlayImageFilter:

Collaboration diagram for itk::simple::LabelMapOverlayImageFilter:

Detailed Description

Apply a colormap to a label map and superimpose it on an image.

Apply a colormap to a label map and put it on top of the feature image. The feature image is typically the image from which the labeling was produced. Use the SetInput function to set the LabelMap , and the SetFeatureImage function to set the feature image.

The set of colors is a good selection of distinct colors. The opacity of the label map can be defined by the user. A background label produce a gray pixel with the same intensity than the input one.

Author

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

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/q6auw4

See also

LabelOverlayImageFilter , LabelOverlayFunctor

LabelMapToRGBImageFilter , LabelMapToBinaryImageFilter , LabelMapToLabelImageFilter

itk::simple::LabelMapOverlay for the procedural interface

itk::LabelMapOverlayImageFilter for the Doxygen on the original ITK class.

Definition at line 59 of file sitkLabelMapOverlayImageFilter.h.

Public Types
using	PixelIDTypeList = LabelPixelIDTypeList
using	Self = LabelMapOverlayImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &labelMapImage, const Image &featureImage)
std::vector< unsigned char >	GetColormap () const
std::string	GetName () const
double	GetOpacity () const
	LabelMapOverlayImageFilter ()
void	SetColormap (std::vector< unsigned char > Colormap)
void	SetOpacity (double Opacity)
std::string	ToString () const
virtual	~LabelMapOverlayImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType

Private Member Functions
template<class TImageType1, class TImageType2>
Image	DualExecuteInternal (const Image *labelMapImage, const Image *featureImage)

Static Private Member Functions
static const detail::DualMemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
std::vector< unsigned char >	m_Colormap { std::vector<unsigned char>() }
double	m_Opacity { 0.5 }

Friends
struct	detail::DualExecuteInternalAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType>
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType>
static Image	CastITKToImage (TImageType *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T>
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

MemberFunctionType

using itk::simple::LabelMapOverlayImageFilter::MemberFunctionType

private

Initial value:

 Image (Self::*)(const Image *
    labelMapImage, const Image *
    featureImage)

Setup for member function dispatching

Definition at line 113 of file sitkLabelMapOverlayImageFilter.h.

PixelIDTypeList

using itk::simple::LabelMapOverlayImageFilter::PixelIDTypeList = LabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 71 of file sitkLabelMapOverlayImageFilter.h.

Self

using itk::simple::LabelMapOverlayImageFilter::Self = LabelMapOverlayImageFilter

Definition at line 61 of file sitkLabelMapOverlayImageFilter.h.

Constructor & Destructor Documentation

~LabelMapOverlayImageFilter()

virtual itk::simple::LabelMapOverlayImageFilter::~LabelMapOverlayImageFilter ( )

virtual

Destructor

LabelMapOverlayImageFilter()

itk::simple::LabelMapOverlayImageFilter::LabelMapOverlayImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

DualExecuteInternal()

template<class TImageType1, class TImageType2>

Image itk::simple::LabelMapOverlayImageFilter::DualExecuteInternal ( const Image * labelMapImage, const Image * featureImage )

private

Execute()

Image itk::simple::LabelMapOverlayImageFilter::Execute	(	const Image &	labelMapImage,
		const Image &	featureImage )

Execute the filter on the input image

Referenced by detail::DualExecuteInternalAddressor< MemberFunctionType >.

GetColormap()

std::vector< unsigned char > itk::simple::LabelMapOverlayImageFilter::GetColormap ( ) const

inline

Definition at line 97 of file sitkLabelMapOverlayImageFilter.h.

References m_Colormap.

GetMemberFunctionFactory()

static const detail::DualMemberFunctionFactory< MemberFunctionType > & itk::simple::LabelMapOverlayImageFilter::GetMemberFunctionFactory ( )

staticprivate

GetName()

std::string itk::simple::LabelMapOverlayImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 101 of file sitkLabelMapOverlayImageFilter.h.

GetOpacity()

double itk::simple::LabelMapOverlayImageFilter::GetOpacity ( ) const

inline

Set/Get the opacity of the colored label image. The value must be between 0 and 1

Definition at line 86 of file sitkLabelMapOverlayImageFilter.h.

References m_Opacity.

SetColormap()

void itk::simple::LabelMapOverlayImageFilter::SetColormap ( std::vector< unsigned char > Colormap )

inline

Definition at line 92 of file sitkLabelMapOverlayImageFilter.h.

References m_Colormap.

SetOpacity()

void itk::simple::LabelMapOverlayImageFilter::SetOpacity ( double Opacity )

inline

Set/Get the opacity of the colored label image. The value must be between 0 and 1

Definition at line 80 of file sitkLabelMapOverlayImageFilter.h.

References m_Opacity.

ToString()

std::string itk::simple::LabelMapOverlayImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::DualExecuteInternalAddressor< MemberFunctionType >

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 108 of file sitkLabelMapOverlayImageFilter.h.

References Execute().

Member Data Documentation

m_Colormap

std::vector<unsigned char> itk::simple::LabelMapOverlayImageFilter::m_Colormap { std::vector<unsigned char>() }

private

Definition at line 130 of file sitkLabelMapOverlayImageFilter.h.

Referenced by GetColormap(), and SetColormap().

m_Opacity

double itk::simple::LabelMapOverlayImageFilter::m_Opacity { 0.5 }

private

Definition at line 128 of file sitkLabelMapOverlayImageFilter.h.

Referenced by GetOpacity(), and SetOpacity().

---

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

• sitkLabelMapOverlayImageFilter.h