#include <itkLabelOverlayImageFilter.h>

Detailed Description

template<typename TInputImage, typename TLabelImage, typename TOutputImage>
class itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >

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://doi.org/10.54294/xr1bvx

See also: LabelToRGBImageFilter; LabelMapOverlayImageFilter, LabelOverlayFunctor

ITK Sphinx Examples:

All ITK Sphinx Examples

Overlay Label Map On Image

Definition at line 56 of file itkLabelOverlayImageFilter.h.

Inheritance diagram for itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >:

Collaboration diagram for itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >:

Public Types
using	ComponentType = typename OutputPixelType::ComponentType

using	ConstPointer = SmartPointer<const Self>

using	FunctorType

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	LabelImageType = TLabelImage

using	LabelPixelType = typename TLabelImage::PixelType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer<Self>

using	Self = LabelOverlayImageFilter

using	Superclass = BinaryGeneratorImageFilter<TInputImage, TLabelImage, TOutputImage>

Public Types inherited from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >
using	ConstPointer

using	ConstRefFunctionType

using	DecoratedInput1ImagePixelType

using	DecoratedInput2ImagePixelType

using	FunctionType

using	Input1ImagePixelType

using	Input1ImagePointer

using	Input1ImageRegionType

using	Input1ImageType

using	Input2ImagePixelType

using	Input2ImagePointer

using	Input2ImageRegionType

using	Input2ImageType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageType

using	Pointer

using	Self

using	Superclass

using	ValueFunctionType

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
using	ConstPointer

using	ConstPointer

using	InputImageConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePixelType

using	InputImagePointer

using	InputImagePointer

using	InputImageRegionType

using	InputImageRegionType

using	InputImageType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Pointer

using	Self

using	Self

using	Superclass

using	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputImagePixelType

using	OutputImageRegionType

using	Pointer = SmartPointer<Self>

using	Self = ImageToImageFilter

using	Superclass = ImageSource<TOutputImage>

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer<Self>

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer<const Self>

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector<DataObjectPointer>

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector<DataObjectIdentifierType>

using	Pointer = SmartPointer<Self>

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
void	AddColor (ComponentType r, ComponentType g, ComponentType b)

virtual::itk::LightObject::Pointer	CreateAnother () const

FunctorType &	GetFunctor ()

virtual const FunctorType &	GetFunctor () const

const char *	GetNameOfClass () const override

unsigned int	GetNumberOfColors () const

void	ResetColors ()


void	SetLabelImage (const TLabelImage *input)

const LabelImageType *	GetLabelImage () const


virtual void	SetOpacity (double _arg)

virtual const double &	GetOpacity () const


virtual void	SetBackgroundValue (LabelPixelType _arg)

virtual const LabelPixelType &	GetBackgroundValue () const

Public Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >
virtual const Input1ImagePixelType &	GetConstant1 () const

virtual const Input1ImagePixelType &	GetConstant1 () const

virtual const Input2ImagePixelType &	GetConstant2 () const

virtual const Input2ImagePixelType &	GetConstant2 () const

virtual void	SetConstant1 (const Input1ImagePixelType &input1)

virtual void	SetConstant1 (const Input1ImagePixelType &input1)

void	SetFunctor (const std::function< ValueFunctionType > &f)

void	SetFunctor (const std::function< ValueFunctionType > &f)

void	SetFunctor (ValueFunctionType *funcPointer)

void	SetFunctor (ValueFunctionType *funcPointer)

virtual void	SetInput1 (const TInputImage *image1)

virtual void	SetInput1 (const DecoratedInput1ImagePixelType *input1)

virtual void	SetInput1 (const Input1ImagePixelType &input1)

virtual void	SetInput1 (const TInputImage *image1)

virtual void	SetInput1 (const DecoratedInput1ImagePixelType *input1)

virtual void	SetInput1 (const Input1ImagePixelType &input1)

virtual void	SetInput2 (const TLabelImage *image2)

virtual void	SetInput2 (const DecoratedInput2ImagePixelType *input2)

virtual void	SetInput2 (const Input2ImagePixelType &input2)

virtual void	SetInput2 (const TLabelImage *image2)

virtual void	SetInput2 (const DecoratedInput2ImagePixelType *input2)

virtual void	SetInput2 (const Input2ImagePixelType &input2)

virtual void	SetConstant2 (const Input2ImagePixelType &input2)

void	SetConstant (Input2ImagePixelType ct)

const Input2ImagePixelType &	GetConstant () const

virtual void	SetConstant2 (const Input2ImagePixelType &input2)

void	SetConstant (Input2ImagePixelType ct)

const Input2ImagePixelType &	GetConstant () const

void	SetFunctor (const std::function< ConstRefFunctionType > &f)

void	SetFunctor (const std::function< ConstRefFunctionType > &f)

void	SetFunctor (ConstRefFunctionType *funcPointer)

void	SetFunctor (ConstRefFunctionType *funcPointer)

void	SetFunctor (const TFunctor &functor)

void	SetFunctor (const TFunctor &functor)

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const

virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *output)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >
static Pointer	New ()

static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	BeforeThreadedGenerateData () override

void	GenerateOutputInformation () override

	LabelOverlayImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~LabelOverlayImageFilter () override=default

Protected Member Functions inherited from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >
	BinaryGeneratorImageFilter ()

	BinaryGeneratorImageFilter ()

	~BinaryGeneratorImageFilter () override=default

	~BinaryGeneratorImageFilter () override=default

void	DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const OutputImageRegionType &outputRegionForThread)

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	AfterThreadedGenerateData () override

void	DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const OutputImageRegionType &outputRegionForThread)

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	AfterThreadedGenerateData () override

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	GetRunningInPlace () const

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

void	AllocateOutputs () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
LabelPixelType	m_BackgroundValue {}

FunctorType	m_Functor {}

double	m_Opacity {}

Additional Inherited Members
Static Public Attributes inherited from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >
static constexpr unsigned int	InputImage1Dimension

static constexpr unsigned int	InputImage1Dimension

static constexpr unsigned int	InputImage2Dimension

static constexpr unsigned int	InputImage2Dimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ComponentType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::ComponentType = typename OutputPixelType::ComponentType

type of the color component.

Definition at line 120 of file itkLabelOverlayImageFilter.h.

◆ ConstPointer

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 72 of file itkLabelOverlayImageFilter.h.

◆ FunctorType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::FunctorType

Initial value:

 Functor::LabelOverlayFunctor<typename TInputImage::PixelType,
                                                   typename TLabelImage::PixelType,
                                                   typename TOutputImage::PixelType>

Definition at line 67 of file itkLabelOverlayImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::InputImageType = TInputImage

Definition at line 76 of file itkLabelOverlayImageFilter.h.

◆ InputPixelType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Definition at line 80 of file itkLabelOverlayImageFilter.h.

◆ LabelImageType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::LabelImageType = TLabelImage

Definition at line 75 of file itkLabelOverlayImageFilter.h.

◆ LabelPixelType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::LabelPixelType = typename TLabelImage::PixelType

Definition at line 79 of file itkLabelOverlayImageFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 74 of file itkLabelOverlayImageFilter.h.

◆ OutputPixelType

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

Definition at line 78 of file itkLabelOverlayImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 71 of file itkLabelOverlayImageFilter.h.

◆ Self

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::Self = LabelOverlayImageFilter

Standard class type aliases.

Definition at line 63 of file itkLabelOverlayImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

using itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::Superclass = BinaryGeneratorImageFilter<TInputImage, TLabelImage, TOutputImage>

Definition at line 65 of file itkLabelOverlayImageFilter.h.

Constructor & Destructor Documentation

◆ LabelOverlayImageFilter()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::LabelOverlayImageFilter ( )

protected

Referenced by GetNameOfClass().

◆ ~LabelOverlayImageFilter()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::~LabelOverlayImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ AddColor()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::AddColor	(	ComponentType	r,
		ComponentType	g,
		ComponentType	b )

Add color to the LUT container.

◆ BeforeThreadedGenerateData()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Process to execute before entering the multithreaded section

Reimplemented from itk::ImageSource< TOutputImage >.

◆ CreateAnother()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

virtual::itk::LightObject::Pointer itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >.

◆ GenerateOutputInformation()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >.

◆ GetBackgroundValue()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

virtual const LabelPixelType & itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetBackgroundValue ( ) const

virtual

Set/Get the background value.

◆ GetFunctor() [1/2]

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

FunctorType & itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetFunctor ( )

inline

Definition at line 129 of file itkLabelOverlayImageFilter.h.

References m_Functor.

◆ GetFunctor() [2/2]

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

virtual const FunctorType & itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetFunctor ( ) const

virtual

◆ GetLabelImage()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

const LabelImageType * itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetLabelImage ( ) const

Set/Get the label image.

◆ GetNameOfClass()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

const char * itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::BinaryGeneratorImageFilter< TInputImage, TLabelImage, TOutputImage >.

References LabelOverlayImageFilter().

◆ GetNumberOfColors()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

unsigned int itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetNumberOfColors ( ) const

Get number of colors in the LUT container.

◆ GetOpacity()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

virtual const double & itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetOpacity ( ) const

virtual

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

◆ New()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

static Pointer itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotectedvirtual

Print internal ivars

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

◆ ResetColors()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::ResetColors ( )

Empty the color LUT container.

◆ SetBackgroundValue()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

virtual void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::SetBackgroundValue ( LabelPixelType _arg )

virtual

Set/Get the background value.

◆ SetLabelImage()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::SetLabelImage ( const TLabelImage * input )

Set/Get the label image.

◆ SetOpacity()

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

virtual void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::SetOpacity ( double _arg )

virtual

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

Member Data Documentation

◆ m_BackgroundValue

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

LabelPixelType itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::m_BackgroundValue {}

private

Definition at line 152 of file itkLabelOverlayImageFilter.h.

◆ m_Functor

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

FunctorType itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::m_Functor {}

private

Definition at line 150 of file itkLabelOverlayImageFilter.h.

Referenced by GetFunctor().

◆ m_Opacity

template<typename TInputImage, typename TLabelImage, typename TOutputImage>

double itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::m_Opacity {}

private

Definition at line 151 of file itkLabelOverlayImageFilter.h.

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

itkLabelOverlayImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ComponentType

◆ ConstPointer

◆ FunctorType

◆ InputImageType

◆ InputPixelType

◆ LabelImageType

◆ LabelPixelType

◆ OutputImageType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LabelOverlayImageFilter()

◆ ~LabelOverlayImageFilter()

Member Function Documentation

◆ AddColor()

◆ BeforeThreadedGenerateData()

◆ CreateAnother()

◆ GenerateOutputInformation()

◆ GetBackgroundValue()

◆ GetFunctor() [1/2]

◆ GetFunctor() [2/2]

◆ GetLabelImage()

◆ GetNameOfClass()

◆ GetNumberOfColors()

◆ GetOpacity()

◆ New()

◆ PrintSelf()

◆ ResetColors()

◆ SetBackgroundValue()

◆ SetLabelImage()

◆ SetOpacity()

Member Data Documentation

◆ m_BackgroundValue

◆ m_Functor

◆ m_Opacity