Apply a colormap to a label image and put it on top of the input image. More...

#include <sitkLabelOverlayImageFilter.h>

Inheritance diagram for itk::simple::LabelOverlayImageFilter:

Collaboration diagram for itk::simple::LabelOverlayImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef LabelOverlayImageFilter	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 &image, const Image &labelImage)

Image	Execute (const Image &image, const Image &labelImage, double opacity, double backgroundValue, std::vector< uint8_t > colormap)

double	GetBackgroundValue () const

std::vector< uint8_t >	GetColormap () const

std::string	GetName () const

double	GetOpacity () const

	LabelOverlayImageFilter ()

Self &	SetBackgroundValue (double BackgroundValue)

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

Self &	SetOpacity (double Opacity)

std::string	ToString () const

virtual	~LabelOverlayImageFilter ()

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 image, const Image labelImage)

Private Member Functions
template<class TImageType1 , class TImageType2 >
Image	DualExecuteInternal (const Image image, const Image labelImage)

Private Attributes
double	m_BackgroundValue

std::vector< uint8_t >	m_Colormap

nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory

double	m_Opacity

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 a label image and put it on top of the input image.

Apply a colormap to a label image 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 image can be defined by the user. The user can also choose if the want to use a background and which label value is the background. 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 class was contributed to the Insight Journal https://hdl.handle.net/1926/172

See also: LabelToRGBImageFilter; LabelMapOverlayImageFilter , LabelOverlayFunctor; itk::simple::LabelOverlay for the procedural interface; itk::LabelOverlayImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkLabelOverlayImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::LabelOverlayImageFilter::MemberFunctionType) (const Image *image, const Image *labelImage)

private

Setup for member function dispatching

Definition at line 111 of file sitkLabelOverlayImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::LabelOverlayImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkLabelOverlayImageFilter.h.

typedef LabelOverlayImageFilter itk::simple::LabelOverlayImageFilter::Self

Definition at line 53 of file sitkLabelOverlayImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::LabelOverlayImageFilter::~LabelOverlayImageFilter ( )

virtual

Destructor

itk::simple::LabelOverlayImageFilter::LabelOverlayImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

template<class TImageType1 , class TImageType2 >

Image itk::simple::LabelOverlayImageFilter::DualExecuteInternal	(	const Image *	image,
		const Image *	labelImage
	)

private

Image itk::simple::LabelOverlayImageFilter::Execute	(	const Image &	image,
		const Image &	labelImage
	)

Execute the filter on the input image

Image itk::simple::LabelOverlayImageFilter::Execute	(	const Image &	image,
		const Image &	labelImage,
		double	opacity,
		double	backgroundValue,
		std::vector< uint8_t >	colormap
	)