Detailed Description

template<typename TLabelObject>
class itk::LabelMap< TLabelObject >

Templated n-dimensional image to store labeled objects.

LabelMap is an image class specialized in storing the labeled images. It represent the image in a different way than itk::Image. Instead of storing the content of the image in an array of pixels values, it store the a collection of labeled objects, and a background value. This way of storing the content of the image allow an easy and efficient manipulation of the objects in the image.

The LabelMap shares a lot of methods with the itk::Image class. it make it usable as input or output of the itk::ImageToImageFilter for example. However the methods don't have the same complexity in the 2 classes, because of the different way to store the data. GetPixel() is run in constant time for example in itk::Image, but have a worst case complexity of O(L), where L is the number of lines in the image (imageSize[1] * imageSize[2] for a 3D image).

To iterate over the LabelObjects in the map, use:

for(unsigned int i = 0; i < filter->GetOutput()->GetNumberOfLabelObjects(); ++i)
  {
  FilterType::OutputImageType::LabelObjectType* labelObject =
    filter->GetOutput()->GetNthLabelObject(i);
  }

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

Wiki Examples:

Examples:: SphinxExamples/src/Filtering/ImageFusion/OverlayLabelMapOnTopOfAnImage/Code.cxx, SphinxExamples/src/Filtering/LabelMap/ApplyMorphologicalClosingOnAllLabelObjects/Code.cxx, SphinxExamples/src/Filtering/LabelMap/ApplyMorphologicalClosingOnSpecificLabelObject/Code.cxx, SphinxExamples/src/Filtering/LabelMap/ExtractGivenLabelObject/Code.cxx, SphinxExamples/src/Filtering/LabelMap/MaskOneImageGivenLabelMap/Code.cxx, and WikiExamples/ImageProcessing/ShapeAttributes.cxx.

Definition at line 70 of file itkLabelMap.h.

Classes
class	ConstIterator

class	Iterator

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ConstWeakPointer = WeakPointer< const Self >

using	DirectionType = typename Superclass::DirectionType

using	IndexType = typename Superclass::IndexType

using	LabelObjectPointerType = typename LabelObjectType::Pointer

using	LabelObjectType = TLabelObject

using	LabelObjectVectorType = std::vector< LabelObjectPointerType >

using	LabelType = typename LabelObjectType::LabelType

using	LabelVectorType = std::vector< LabelType >

using	LengthType = SizeValueType

using	OffsetType = typename Superclass::OffsetType

using	OffsetValueType = typename Superclass::OffsetValueType

using	PixelType = LabelType

using	Pointer = SmartPointer< Self >

using	PointType = typename Superclass::PointType

using	RegionType = typename Superclass::RegionType

using	Self = LabelMap

using	SizeType = typename Superclass::SizeType

using	SizeValueType = typename Superclass::SizeValueType

using	SpacingType = typename Superclass::SpacingType

using	Superclass = ImageBase< TLabelObject::ImageDimension >

Public Types inherited from itk::ImageBase< TLabelObject::ImageDimension >
using	ConstPointer = SmartPointer< const Self >

using	DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >

using	ImageDimensionType = unsigned int

using	IndexType = Index< VImageDimension >

using	IndexValueType = typename IndexType::IndexValueType

using	OffsetType = Offset< VImageDimension >

using	OffsetValueType = typename OffsetType::OffsetValueType

using	Pointer = SmartPointer< Self >

using	PointType = Point< PointValueType, VImageDimension >

using	PointValueType = SpacePrecisionType

using	RegionType = ImageRegion< VImageDimension >

using	Self = ImageBase

using	SizeType = Size< VImageDimension >

using	SizeValueType = typename SizeType::SizeValueType

using	SpacingType = Vector< SpacingValueType, VImageDimension >

using	SpacingValueType = SpacePrecisionType

using	Superclass = DataObject

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

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type

using	Pointer = SmartPointer< Self >

using	Self = DataObject

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	AddLabelObject (LabelObjectType *labelObject)

void	AddPixel (const IndexType &idx, const LabelType &label)

void	Allocate (bool initialize=false) override

void	ClearLabels ()

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

LabelObjectType *	GetLabelObject (const IndexType &idx) const

LabelObjectVectorType	GetLabelObjects () const

LabelVectorType	GetLabels () const

virtual const char *	GetNameOfClass () const

Self::SizeValueType	GetNumberOfLabelObjects () const

const LabelType &	GetPixel (const IndexType &idx) const

virtual void	Graft (const Self *imgData)

bool	HasLabel (const LabelType label) const

void	Initialize () override

void	Optimize ()

void	PrintLabelObjects (std::ostream &os) const

void	PrintLabelObjects () const

void	PushLabelObject (LabelObjectType *labelObject)

void	RemoveLabel (const LabelType &label)

void	RemoveLabelObject (LabelObjectType *labelObject)

void	RemovePixel (const IndexType &idx, const LabelType &label)

void	SetLine (const IndexType &idx, const LengthType &length, const LabelType &label)

void	SetPixel (const IndexType &idx, const LabelType &label)


LabelObjectType *	GetLabelObject (const LabelType &label)

const LabelObjectType *	GetLabelObject (const LabelType &label) const


LabelObjectType *	GetNthLabelObject (const SizeValueType &pos)

const LabelObjectType *	GetNthLabelObject (const SizeValueType &pos) const


virtual LabelType	GetBackgroundValue () const

virtual void	SetBackgroundValue (LabelType _arg)

Public Member Functions inherited from itk::ImageBase< TLabelObject::ImageDimension >
OffsetValueType	ComputeOffset (const IndexType &ind) const

void	CopyInformation (const DataObject *data) override

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

virtual const RegionType &	GetBufferedRegion () const

virtual const DirectionType &	GetDirection () const

virtual const DirectionType &	GetInverseDirection () const

virtual const RegionType &	GetLargestPossibleRegion () const

virtual const PointType &	GetOrigin () const

virtual const RegionType &	GetRequestedRegion () const

virtual const SpacingType &	GetSpacing () const

void	Initialize () override

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

virtual void	SetBufferedRegion (const RegionType &region)

virtual void	SetDirection (const DirectionType &direction)

virtual void	SetLargestPossibleRegion (const RegionType &region)

virtual void	SetRegions (const SizeType &size)

virtual void	SetRequestedRegion (const RegionType &region)

void	SetRequestedRegion (const DataObject *data) override

void	SetRequestedRegionToLargestPossibleRegion () override

void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const

bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const

void	TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const

void	UpdateOutputData () override

void	UpdateOutputInformation () override

bool	VerifyRequestedRegion () override

virtual void	SetOrigin (PointType _arg)

virtual void	SetOrigin (const double origin[VImageDimension])

virtual void	SetOrigin (const float origin[VImageDimension])

virtual void	SetRegions (const RegionType &region)

const OffsetValueType *	GetOffsetTable () const

IndexType	ComputeIndex (OffsetValueType offset) const

virtual void	SetSpacing (const SpacingType &spacing)

virtual void	SetSpacing (const double spacing[VImageDimension])

virtual void	SetSpacing (const float spacing[VImageDimension])

bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const

void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const

void	TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const

virtual unsigned int	GetNumberOfComponentsPerPixel () const

virtual void	SetNumberOfComponentsPerPixel (unsigned int)

Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

virtual void	Update ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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

unsigned long	AddObserver (const EventObject &event, Command *) 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 noexceptoverride

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
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageBase< TLabelObject::ImageDimension >
static unsigned int	GetImageDimension ()

static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = LabelObjectType::ImageDimension

Static Public Attributes inherited from itk::ImageBase< TLabelObject::ImageDimension >
static constexpr ImageDimensionType	ImageDimension

Protected Member Functions
void	Graft (const DataObject *data) override

	LabelMap ()

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

	~LabelMap () override=default

Protected Member Functions inherited from itk::ImageBase< TLabelObject::ImageDimension >
virtual void	ComputeIndexToPhysicalPointMatrices ()

void	ComputeOffsetTable ()

void	Graft (const DataObject *data) override

	ImageBase ()

virtual void	InitializeBufferedRegion ()

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

	~ImageBase () override=default

OffsetValueType	FastComputeOffset (const IndexType &ind) const

IndexType	FastComputeIndex (OffsetValueType offset) const

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

	~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 Types
using	LabelObjectContainerConstIterator = typename LabelObjectContainerType::const_iterator

using	LabelObjectContainerIterator = typename LabelObjectContainerType::iterator

using	LabelObjectContainerType = std::map< LabelType, LabelObjectPointerType >

Private Member Functions
void	AddPixel (const LabelObjectContainerIterator &it, const IndexType &idx, const LabelType &iLabel)

void	RemovePixel (const LabelObjectContainerIterator &it, const IndexType &idx, bool iEmitModifiedEvent)

Private Attributes
LabelType	m_BackgroundValue

LabelObjectContainerType	m_LabelObjectContainer

Additional Inherited Members
Protected Attributes inherited from itk::ImageBase< TLabelObject::ImageDimension >
DirectionType	m_Direction

DirectionType	m_IndexToPhysicalPoint

DirectionType	m_InverseDirection

PointType	m_Origin

DirectionType	m_PhysicalPointToIndex

SpacingType	m_Spacing

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