itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage > Class Template Reference

#include <itkLabelMapOverlayImageFilter.h>

Inheritance diagram for itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >:

Collaboration diagram for itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	FeatureImageConstPointer = typename FeatureImageType::ConstPointer
using	FeatureImagePixelType = typename FeatureImageType::PixelType
using	FeatureImagePointer = typename FeatureImageType::Pointer
using	FeatureImageRegionType = typename FeatureImageType::RegionType
using	FeatureImageType = TFeatureImage
using	FunctorType = typename Functor::LabelOverlayFunctor< FeatureImagePixelType, LabelMapPixelType, OutputImagePixelType >
using	IndexType = typename OutputImageType::IndexType
using	LabelMapConstPointer = typename LabelMapType::ConstPointer
using	LabelMapPixelType = typename LabelMapType::PixelType
using	LabelMapPointer = typename LabelMapType::Pointer
using	LabelMapRegionType = typename LabelMapType::RegionType
using	LabelMapType = TLabelMap
using	LabelObjectType = typename LabelMapType::LabelObjectType
using	LabelType = typename LabelObjectType::LabelType
using	LengthType = typename LabelObjectType::LengthType
using	OutputImageConstPointer = typename OutputImageType::ConstPointer
using	OutputImagePixelType = typename OutputImageType::PixelType
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TOutputImage
using	Pointer = SmartPointer< Self >
using	RegionType = typename OutputImageType::RegionType
using	Self = LabelMapOverlayImageFilter
using	SizeType = typename OutputImageType::SizeType
using	Superclass = LabelMapFilter< TLabelMap, TOutputImage >
Public Types inherited from itk::LabelMapFilter< TLabelMap, TOutputImage >
using	ConstPointer = SmartPointer< const Self >
using	InputImageConstPointer = typename Superclass::InputImageConstPointer
using	InputImagePixelType = typename Superclass::InputImagePixelType
using	InputImagePointer = typename Superclass::InputImagePointer
using	InputImageRegionType = typename Superclass::InputImageRegionType
using	InputImageType = typename Superclass::InputImageType
using	LabelObjectType = typename InputImageType::LabelObjectType
using	OutputImageConstPointer = typename OutputImageType::ConstPointer
using	OutputImagePixelType = typename OutputImageType::PixelType
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TOutputImage
using	Pointer = SmartPointer< Self >
using	Self = LabelMapFilter
using	Superclass = ImageToImageFilter< TLabelMap, TOutputImage >
Public Types inherited from itk::ImageToImageFilter< TLabelMap, 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 = TLabelMap
using	OutputImagePixelType = typename Superclass::OutputImagePixelType
using	OutputImageRegionType = typename Superclass::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
virtual ::itk::LightObject::Pointer	CreateAnother () const
const FeatureImageType *	GetFeatureImage ()
virtual const char *	GetNameOfClass () const
void	SetFeatureImage (const TFeatureImage *input)
void	SetInput1 (const TLabelMap *input)
void	SetInput2 (const TFeatureImage *input)
Public Member Functions inherited from itk::LabelMapFilter< TLabelMap, TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	EnlargeOutputRequestedRegion (DataObject *) override
void	GenerateInputRequestedRegion () override
Public Member Functions inherited from itk::ImageToImageFilter< TLabelMap, 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 DataObjectIdentifierType &key, DataObject *input)
virtual void	SetInput (const InputImageType *input)
virtual void	SetInput (unsigned int, const TLabelMap *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 ()
const OutputImageType *	GetOutput () const
OutputImageType *	GetOutput (unsigned int idx)
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 const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
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	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
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
MultiThreaderType *	GetMultiThreader () const
void	SetMultiThreader (MultiThreaderType *threader)
virtual void	PrepareOutputs ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
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)
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::LabelMapFilter< TLabelMap, TOutputImage >
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageToImageFilter< TLabelMap, TOutputImage >
static void	SetGlobalDefaultDirectionTolerance (double)
static double	GetGlobalDefaultDirectionTolerance ()
static void	SetGlobalDefaultCoordinateTolerance (double)
static double	GetGlobalDefaultCoordinateTolerance ()
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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension
static constexpr unsigned int	InputImageDimension = TLabelMap::ImageDimension
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::LabelMapFilter< TLabelMap, TOutputImage >
static constexpr unsigned int	InputImageDimension
static constexpr unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TLabelMap, TOutputImage >
static constexpr unsigned int	InputImageDimension
static constexpr unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
double	m_Opacity
FunctorType	m_Functor
virtual void	SetOpacity (double _arg)
virtual const double &	GetOpacity () const
virtual void	SetFunctor (const FunctorType &functor)
FunctorType &	GetFunctor ()
const FunctorType &	GetFunctor () const
	LabelMapOverlayImageFilter ()
	~LabelMapOverlayImageFilter () override=default
void	GenerateInputRequestedRegion () override
void	EnlargeOutputRequestedRegion (DataObject *) override
void	GenerateData () override
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
void	SuperclassDynamicTGD (const OutputImageRegionType &outputRegion)
void	ThreadedProcessLabelObject (LabelObjectType *labelObject) override
void	GenerateOutputInformation () override
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TLabelMap, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
Protected Member Functions inherited from itk::LabelMapFilter< TLabelMap, TOutputImage >
void	AfterThreadedGenerateData () override
void	BeforeThreadedGenerateData () override
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
virtual InputImageType *	GetLabelMap ()
	LabelMapFilter ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType) override
virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)
	~LabelMapFilter () override=default
Protected Member Functions inherited from itk::ImageToImageFilter< TLabelMap, TOutputImage >
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
	ImageToImageFilter ()
	~ImageToImageFilter () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyInputInformation () ITKv5_CONST override
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
	ImageSource ()
	~ImageSource () override=default
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
virtual void	AllocateOutputs ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()
	~ProcessObject () override
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
virtual void	AddInput (DataObject *input)
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
virtual void	SetPrimaryInput (DataObject *object)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
void	SetRequiredInputNames (const NameArray &)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
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
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	SetPrimaryOutput (DataObject *object)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
virtual void	AddOutput (DataObject *output)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
virtual void	VerifyPreconditions () ITKv5_CONST
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	RestoreInputReleaseDataFlags ()
virtual bool	GetThreaderUpdateProgress () const
virtual void	ThreaderUpdateProgressOn ()
virtual void	ThreaderUpdateProgressOff ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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 ()
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
static constexpr float	progressFixedToFloat (uint32_t fixed)
static uint32_t	progressFloatToFixed (float f)
Protected Attributes inherited from itk::LabelMapFilter< TLabelMap, TOutputImage >
std::mutex	m_LabelObjectContainerLock
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<typename TLabelMap, typename TFeatureImage, typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>
class itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >

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://www.insight-journal.org/browse/publication/176

See also

LabelOverlayImageFilter, LabelOverlayFunctor

LabelMapToRGBImageFilter, LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Color Labeled Regions In Image

Examples

SphinxExamples/src/Filtering/ImageFusion/ColorLabeledRegions/Code.cxx, and SphinxExamples/src/Filtering/ImageFusion/OverlayLabelMapOnTopOfAnImage/Code.cxx.

Definition at line 59 of file itkLabelMapOverlayImageFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 68 of file itkLabelMapOverlayImageFilter.h.

FeatureImageConstPointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImageConstPointer = typename FeatureImageType::ConstPointer

Definition at line 82 of file itkLabelMapOverlayImageFilter.h.

FeatureImagePixelType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImagePixelType = typename FeatureImageType::PixelType

Definition at line 84 of file itkLabelMapOverlayImageFilter.h.

FeatureImagePointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImagePointer = typename FeatureImageType::Pointer

Definition at line 81 of file itkLabelMapOverlayImageFilter.h.

FeatureImageRegionType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImageRegionType = typename FeatureImageType::RegionType

Definition at line 83 of file itkLabelMapOverlayImageFilter.h.

FeatureImageType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FeatureImageType = TFeatureImage

Definition at line 80 of file itkLabelMapOverlayImageFilter.h.

FunctorType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::FunctorType = typename Functor::LabelOverlayFunctor<FeatureImagePixelType, LabelMapPixelType, OutputImagePixelType>

Definition at line 96 of file itkLabelMapOverlayImageFilter.h.

IndexType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 91 of file itkLabelMapOverlayImageFilter.h.

LabelMapConstPointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapConstPointer = typename LabelMapType::ConstPointer

Definition at line 73 of file itkLabelMapOverlayImageFilter.h.

LabelMapPixelType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapPixelType = typename LabelMapType::PixelType

Definition at line 75 of file itkLabelMapOverlayImageFilter.h.

LabelMapPointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapPointer = typename LabelMapType::Pointer

Definition at line 72 of file itkLabelMapOverlayImageFilter.h.

LabelMapRegionType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapRegionType = typename LabelMapType::RegionType

Definition at line 74 of file itkLabelMapOverlayImageFilter.h.

LabelMapType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapType = TLabelMap

Some convenient type alias.

Definition at line 71 of file itkLabelMapOverlayImageFilter.h.

LabelObjectType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelObjectType = typename LabelMapType::LabelObjectType

Definition at line 76 of file itkLabelMapOverlayImageFilter.h.

LabelType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelType = typename LabelObjectType::LabelType

Definition at line 77 of file itkLabelMapOverlayImageFilter.h.

LengthType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LengthType = typename LabelObjectType::LengthType

Definition at line 78 of file itkLabelMapOverlayImageFilter.h.

OutputImageConstPointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 88 of file itkLabelMapOverlayImageFilter.h.

OutputImagePixelType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 90 of file itkLabelMapOverlayImageFilter.h.

OutputImagePointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 87 of file itkLabelMapOverlayImageFilter.h.

OutputImageRegionType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 89 of file itkLabelMapOverlayImageFilter.h.

OutputImageType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 86 of file itkLabelMapOverlayImageFilter.h.

Pointer

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 67 of file itkLabelMapOverlayImageFilter.h.

RegionType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::RegionType = typename OutputImageType::RegionType

Definition at line 93 of file itkLabelMapOverlayImageFilter.h.

Self

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::Self = LabelMapOverlayImageFilter

Standard class type aliases.

Definition at line 65 of file itkLabelMapOverlayImageFilter.h.

SizeType

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SizeType = typename OutputImageType::SizeType

Definition at line 92 of file itkLabelMapOverlayImageFilter.h.

Superclass

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

using itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::Superclass = LabelMapFilter<TLabelMap, TOutputImage>

Definition at line 66 of file itkLabelMapOverlayImageFilter.h.

Constructor & Destructor Documentation

LabelMapOverlayImageFilter()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::LabelMapOverlayImageFilter ( )

protected

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

~LabelMapOverlayImageFilter()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::~LabelMapOverlayImageFilter ( )

overrideprotecteddefault

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

Member Function Documentation

CreateAnother()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

virtual::itk::LightObject::Pointer itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, 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::Object.

DynamicThreadedGenerateData()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread )

overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

EnlargeOutputRequestedRegion()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject *  )

overrideprotectedvirtual

LabelMapOverlayImageFilter will produce the entire output.

Reimplemented from itk::ProcessObject.

GenerateData()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

GenerateInputRequestedRegion()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

LabelMapOverlayImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

Reimplemented from itk::ProcessObject.

GenerateOutputInformation()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

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

Reimplemented from itk::ProcessObject.

GetFeatureImage()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

const FeatureImageType* itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GetFeatureImage ( )

inline

Get the feature image

Definition at line 119 of file itkLabelMapOverlayImageFilter.h.

References itk::ProcessObject::GetInput().

GetFunctor() [1/2]

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

FunctorType& itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GetFunctor ( )

inline

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

Definition at line 158 of file itkLabelMapOverlayImageFilter.h.

GetFunctor() [2/2]

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

const FunctorType& itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GetFunctor ( ) const

inline

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

Definition at line 163 of file itkLabelMapOverlayImageFilter.h.

GetNameOfClass()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

virtual const char* itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from itk::LabelMapFilter< TLabelMap, TOutputImage >.

GetOpacity()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

virtual const double& itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::GetOpacity ( ) const

virtual

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

New()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

static Pointer itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::New ( )

static

Standard New method.

PrintSelf()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

SetFeatureImage()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SetFeatureImage ( const TFeatureImage *  input )

inline

Set the feature image

Definition at line 111 of file itkLabelMapOverlayImageFilter.h.

SetFunctor()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

virtual void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SetFunctor ( const FunctorType &  functor )

inlinevirtual

Set/Get the overlay functor - defaults to a reasonable set of colors. This can be used to apply a different colormap.

Definition at line 149 of file itkLabelMapOverlayImageFilter.h.

SetInput1()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SetInput1 ( const TLabelMap *  input )

inline

Set the input image

Definition at line 126 of file itkLabelMapOverlayImageFilter.h.

SetInput2()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SetInput2 ( const TFeatureImage *  input )

inline

Set the feature image

Definition at line 133 of file itkLabelMapOverlayImageFilter.h.

SetOpacity()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

virtual void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SetOpacity ( double  _arg )

virtual

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

SuperclassDynamicTGD()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::SuperclassDynamicTGD ( const OutputImageRegionType &  outputRegion )

inlineprotected

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

Definition at line 191 of file itkLabelMapOverlayImageFilter.h.

ThreadedProcessLabelObject()

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

void itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::ThreadedProcessLabelObject ( LabelObjectType *  labelObject )

overrideprotected

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

Member Data Documentation

ImageDimension

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

constexpr unsigned int itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 101 of file itkLabelMapOverlayImageFilter.h.

InputImageDimension

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

constexpr unsigned int itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::InputImageDimension = TLabelMap::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 99 of file itkLabelMapOverlayImageFilter.h.

m_Functor

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

FunctorType itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::m_Functor

private

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

Definition at line 207 of file itkLabelMapOverlayImageFilter.h.

m_Opacity

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

double itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::m_Opacity

private

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

Definition at line 206 of file itkLabelMapOverlayImageFilter.h.

OutputImageDimension

template<typename TLabelMap , typename TFeatureImage , typename TOutputImage = Image<RGBPixel<typename TFeatureImage::PixelType>, TFeatureImage::ImageDimension>>

constexpr unsigned int itk::LabelMapOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 100 of file itkLabelMapOverlayImageFilter.h.

---

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

• itkLabelMapOverlayImageFilter.h