itk::simple::LabelMapContourOverlayImageFilter Class Reference

Apply a colormap to the contours (outlines) of each object in a label map and superimpose it on top of the feature image. More...

#include <sitkLabelMapContourOverlayImageFilter.h>

Inheritance diagram for itk::simple::LabelMapContourOverlayImageFilter:

Collaboration diagram for itk::simple::LabelMapContourOverlayImageFilter:

Detailed Description

Apply a colormap to the contours (outlines) of each object in a label map and superimpose 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.

Apply a colormap to a label map and put it on top of the input 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

LabelMapOverlayImageFilter , LabelOverlayImageFilter , LabelOverlayFunctor

LabelMapToBinaryImageFilter , LabelMapToLabelImageFilter ,

itk::simple::LabelMapContourOverlay for the procedural interface

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

Definition at line 54 of file sitkLabelMapContourOverlayImageFilter.h.

Public Types
enum	ContourTypeType {   PLAIN,   CONTOUR,   SLICE_CONTOUR }
using	PixelIDTypeList = LabelPixelIDTypeList
enum	PriorityType {   HIGH_LABEL_ON_TOP,   LOW_LABEL_ON_TOP }
using	Self = LabelMapContourOverlayImageFilter
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< uint8_t >	GetColormap () const
std::vector< unsigned int >	GetContourThickness () const
ContourTypeType	GetContourType () const
std::vector< unsigned int >	GetDilationRadius () const
std::string	GetName () const
double	GetOpacity () const
PriorityType	GetPriority () const
unsigned int	GetSliceDimension () const
	LabelMapContourOverlayImageFilter ()
Self &	SetColormap (std::vector< uint8_t > Colormap)
Self &	SetContourThickness (std::vector< unsigned int > ContourThickness)
Self &	SetContourType (ContourTypeType ContourType)
Self &	SetDilationRadius (std::vector< unsigned int > DilationRadius)
Self &	SetDilationRadius (unsigned int value)
Self &	SetOpacity (double Opacity)
Self &	SetPriority (PriorityType Priority)
Self &	SetSliceDimension (unsigned int SliceDimension)
std::string	ToString () const
virtual	~LabelMapContourOverlayImageFilter ()
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. More...
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
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 = Image(Self::*)(const Image *labelMapImage, const Image *featureImage)

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

Private Attributes
std::vector< uint8_t >	m_Colormap {std::vector<uint8_t>()}
std::vector< unsigned int >	m_ContourThickness {std::vector<unsigned int>(3, 1)}
ContourTypeType	m_ContourType {itk::simple::LabelMapContourOverlayImageFilter::CONTOUR}
std::vector< unsigned int >	m_DilationRadius {std::vector<unsigned int>(3, 1)}
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory
double	m_Opacity {0.5}
PriorityType	m_Priority {itk::simple::LabelMapContourOverlayImageFilter::HIGH_LABEL_ON_TOP}
unsigned int	m_SliceDimension {0u}

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. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...
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::LabelMapContourOverlayImageFilter::MemberFunctionType = Image (Self::*)( const Image * labelMapImage, const Image * featureImage )

private

Setup for member function dispatching

Definition at line 161 of file sitkLabelMapContourOverlayImageFilter.h.

PixelIDTypeList

using itk::simple::LabelMapContourOverlayImageFilter::PixelIDTypeList = LabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkLabelMapContourOverlayImageFilter.h.

Self

using itk::simple::LabelMapContourOverlayImageFilter::Self = LabelMapContourOverlayImageFilter

Definition at line 56 of file sitkLabelMapContourOverlayImageFilter.h.

Member Enumeration Documentation

ContourTypeType

enum itk::simple::LabelMapContourOverlayImageFilter::ContourTypeType

Enumerator
PLAIN
CONTOUR
SLICE_CONTOUR

Definition at line 113 of file sitkLabelMapContourOverlayImageFilter.h.

PriorityType

enum itk::simple::LabelMapContourOverlayImageFilter::PriorityType

Enumerator
HIGH_LABEL_ON_TOP
LOW_LABEL_ON_TOP

Definition at line 127 of file sitkLabelMapContourOverlayImageFilter.h.

Constructor & Destructor Documentation

~LabelMapContourOverlayImageFilter()

virtual itk::simple::LabelMapContourOverlayImageFilter::~LabelMapContourOverlayImageFilter ( )

virtual

Destructor

LabelMapContourOverlayImageFilter()

itk::simple::LabelMapContourOverlayImageFilter::LabelMapContourOverlayImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

DualExecuteInternal()

template<class TImageType1 , class TImageType2 >

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

private

Execute()

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

Execute the filter on the input image

GetColormap()

std::vector<uint8_t> itk::simple::LabelMapContourOverlayImageFilter::GetColormap ( ) const

inline

Definition at line 145 of file sitkLabelMapContourOverlayImageFilter.h.

GetContourThickness()

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::GetContourThickness ( ) const

inline

Set/Get the contour thickness - 1 by default.

Definition at line 101 of file sitkLabelMapContourOverlayImageFilter.h.

GetContourType()

ContourTypeType itk::simple::LabelMapContourOverlayImageFilter::GetContourType ( ) const

inline

Set/Get the overlay type - CONTOUR is used by default.

Definition at line 125 of file sitkLabelMapContourOverlayImageFilter.h.

GetDilationRadius()

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::GetDilationRadius ( ) const

inline

Set/Get the object dilation radius - 0 by default.

Definition at line 91 of file sitkLabelMapContourOverlayImageFilter.h.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 148 of file sitkLabelMapContourOverlayImageFilter.h.

GetOpacity()

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

inline

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

Definition at line 78 of file sitkLabelMapContourOverlayImageFilter.h.

GetPriority()

PriorityType itk::simple::LabelMapContourOverlayImageFilter::GetPriority ( ) const

inline

Set/Get the object priority - HIGH_LABEL_ON_TOP by default.

Definition at line 137 of file sitkLabelMapContourOverlayImageFilter.h.

GetSliceDimension()

unsigned int itk::simple::LabelMapContourOverlayImageFilter::GetSliceDimension ( ) const

inline

Set/Get the slice dimension - defaults to image dimension - 1.

Definition at line 111 of file sitkLabelMapContourOverlayImageFilter.h.

SetColormap()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetColormap ( std::vector< uint8_t >  Colormap )

inline

Definition at line 141 of file sitkLabelMapContourOverlayImageFilter.h.

SetContourThickness()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetContourThickness ( std::vector< unsigned int >  ContourThickness )

inline

Set/Get the contour thickness - 1 by default.

Definition at line 96 of file sitkLabelMapContourOverlayImageFilter.h.

SetContourType()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetContourType ( ContourTypeType  ContourType )

inline

Set/Get the overlay type - CONTOUR is used by default.

Definition at line 119 of file sitkLabelMapContourOverlayImageFilter.h.

SetDilationRadius() [1/2]

Self& itk::simple::LabelMapContourOverlayImageFilter::SetDilationRadius ( std::vector< unsigned int >  DilationRadius )

inline

Set/Get the object dilation radius - 0 by default.

Definition at line 83 of file sitkLabelMapContourOverlayImageFilter.h.

SetDilationRadius() [2/2]

Self& itk::simple::LabelMapContourOverlayImageFilter::SetDilationRadius ( unsigned int  value )

inline

Set the values of the DilationRadius vector all to value

Definition at line 86 of file sitkLabelMapContourOverlayImageFilter.h.

SetOpacity()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetOpacity ( double  Opacity )

inline

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

Definition at line 73 of file sitkLabelMapContourOverlayImageFilter.h.

SetPriority()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetPriority ( PriorityType  Priority )

inline

Set/Get the object priority - HIGH_LABEL_ON_TOP by default.

Definition at line 132 of file sitkLabelMapContourOverlayImageFilter.h.

SetSliceDimension()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetSliceDimension ( unsigned int  SliceDimension )

inline

Set/Get the slice dimension - defaults to image dimension - 1.

Definition at line 106 of file sitkLabelMapContourOverlayImageFilter.h.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

detail::DualExecuteInternalAddressor< MemberFunctionType >

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 163 of file sitkLabelMapContourOverlayImageFilter.h.

Member Data Documentation

m_Colormap

std::vector<uint8_t> itk::simple::LabelMapContourOverlayImageFilter::m_Colormap {std::vector<uint8_t>()}

private

Definition at line 183 of file sitkLabelMapContourOverlayImageFilter.h.

m_ContourThickness

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::m_ContourThickness {std::vector<unsigned int>(3, 1)}

private

Definition at line 175 of file sitkLabelMapContourOverlayImageFilter.h.

m_ContourType

ContourTypeType itk::simple::LabelMapContourOverlayImageFilter::m_ContourType {itk::simple::LabelMapContourOverlayImageFilter::CONTOUR}

private

Definition at line 179 of file sitkLabelMapContourOverlayImageFilter.h.

m_DilationRadius

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::m_DilationRadius {std::vector<unsigned int>(3, 1)}

private

Definition at line 173 of file sitkLabelMapContourOverlayImageFilter.h.

m_DualMemberFactory

std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::LabelMapContourOverlayImageFilter::m_DualMemberFactory

private

Definition at line 167 of file sitkLabelMapContourOverlayImageFilter.h.

m_Opacity

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

private

Definition at line 171 of file sitkLabelMapContourOverlayImageFilter.h.

m_Priority

PriorityType itk::simple::LabelMapContourOverlayImageFilter::m_Priority {itk::simple::LabelMapContourOverlayImageFilter::HIGH_LABEL_ON_TOP}

private

Definition at line 181 of file sitkLabelMapContourOverlayImageFilter.h.

m_SliceDimension

unsigned int itk::simple::LabelMapContourOverlayImageFilter::m_SliceDimension {0u}

private

Definition at line 177 of file sitkLabelMapContourOverlayImageFilter.h.

---

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

• sitkLabelMapContourOverlayImageFilter.h