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:

Public Types
enum	ContourTypeType {   PLAIN,   CONTOUR,   SLICE_CONTOUR }
typedef LabelPixelIDTypeList	PixelIDTypeList
enum	PriorityType {   HIGH_LABEL_ON_TOP,   LOW_LABEL_ON_TOP }
typedef LabelMapContourOverlayImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &labelMapImage, const Image &featureImage)
Image	Execute (const Image &labelMapImage, const Image &featureImage, double opacity, const std::vector< unsigned int > &dilationRadius, const std::vector< unsigned int > &contourThickness, unsigned int sliceDimension, LabelMapContourOverlayImageFilter::ContourTypeType contourType, LabelMapContourOverlayImageFilter::PriorityType priority, std::vector< uint8_t > colormap)
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 (const std::vector< unsigned int > &ContourThickness)
Self &	SetContourType (ContourTypeType ContourType)
Self &	SetDilationRadius (const 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< 0 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
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

Private Types
typedef Image(Self::*	MemberFunctionType) (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< unsigned int >	m_ContourThickness
ContourTypeType	m_ContourType
std::vector< unsigned int >	m_DilationRadius
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory
double	m_Opacity
PriorityType	m_Priority
unsigned int	m_SliceDimension

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
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...
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) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)
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)

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://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

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 53 of file sitkLabelMapContourOverlayImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::LabelMapContourOverlayImageFilter::MemberFunctionType) (const Image *labelMapImage, const Image *featureImage)

private

Setup for member function dispatching

Definition at line 163 of file sitkLabelMapContourOverlayImageFilter.h.

typedef LabelPixelIDTypeList itk::simple::LabelMapContourOverlayImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkLabelMapContourOverlayImageFilter.h.

typedef LabelMapContourOverlayImageFilter itk::simple::LabelMapContourOverlayImageFilter::Self

Definition at line 55 of file sitkLabelMapContourOverlayImageFilter.h.

Member Enumeration Documentation

enum itk::simple::LabelMapContourOverlayImageFilter::ContourTypeType

Enumerator
PLAIN
CONTOUR
SLICE_CONTOUR

Definition at line 113 of file sitkLabelMapContourOverlayImageFilter.h.

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

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

virtual

Destructor

itk::simple::LabelMapContourOverlayImageFilter::LabelMapContourOverlayImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

template<class TImageType1 , class TImageType2 >

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

private

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

Execute the filter on the input image

Image itk::simple::LabelMapContourOverlayImageFilter::Execute	(	const Image &	labelMapImage,
		const Image &	featureImage,
		double	opacity,
		const std::vector< unsigned int > &	dilationRadius,
		const std::vector< unsigned int > &	contourThickness,
		unsigned int	sliceDimension,
		LabelMapContourOverlayImageFilter::ContourTypeType	contourType,
		LabelMapContourOverlayImageFilter::PriorityType	priority,
		std::vector< uint8_t >	colormap
	)

Execute the filter on the input image with the given parameters

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

inline

Definition at line 145 of file sitkLabelMapContourOverlayImageFilter.h.

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.

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.

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.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 147 of file sitkLabelMapContourOverlayImageFilter.h.

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 77 of file sitkLabelMapContourOverlayImageFilter.h.

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.

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.

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

inline

Definition at line 141 of file sitkLabelMapContourOverlayImageFilter.h.

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

inline

Set/Get the contour thickness - 1 by default.

Definition at line 96 of file sitkLabelMapContourOverlayImageFilter.h.

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.

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

inline

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

Definition at line 82 of file sitkLabelMapContourOverlayImageFilter.h.

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

inline

Set the values of the DilationRadius vector all to value

Definition at line 85 of file sitkLabelMapContourOverlayImageFilter.h.

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 72 of file sitkLabelMapContourOverlayImageFilter.h.

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.

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.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 165 of file sitkLabelMapContourOverlayImageFilter.h.

Member Data Documentation

std::vector<uint8_t> itk::simple::LabelMapContourOverlayImageFilter::m_Colormap

private

Definition at line 179 of file sitkLabelMapContourOverlayImageFilter.h.

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::m_ContourThickness

private

Definition at line 175 of file sitkLabelMapContourOverlayImageFilter.h.

ContourTypeType itk::simple::LabelMapContourOverlayImageFilter::m_ContourType

private

Definition at line 177 of file sitkLabelMapContourOverlayImageFilter.h.

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::m_DilationRadius

private

Definition at line 174 of file sitkLabelMapContourOverlayImageFilter.h.

nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::LabelMapContourOverlayImageFilter::m_DualMemberFactory

private

Definition at line 169 of file sitkLabelMapContourOverlayImageFilter.h.

double itk::simple::LabelMapContourOverlayImageFilter::m_Opacity

private

Definition at line 173 of file sitkLabelMapContourOverlayImageFilter.h.

PriorityType itk::simple::LabelMapContourOverlayImageFilter::m_Priority

private

Definition at line 178 of file sitkLabelMapContourOverlayImageFilter.h.

unsigned int itk::simple::LabelMapContourOverlayImageFilter::m_SliceDimension

private

Definition at line 176 of file sitkLabelMapContourOverlayImageFilter.h.

---

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

• sitkLabelMapContourOverlayImageFilter.h