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
typedef SmartPointer< const Self >	ConstPointer

typedef WeakPointer< const Self >	ConstWeakPointer

typedef Superclass::DirectionType	DirectionType

typedef Superclass::IndexType	IndexType

typedef LabelObjectType::Pointer	LabelObjectPointerType

typedef TLabelObject	LabelObjectType

typedef std::vector < LabelObjectPointerType >	LabelObjectVectorType

typedef LabelObjectType::LabelType	LabelType

typedef std::vector< LabelType >	LabelVectorType

typedef SizeValueType	LengthType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::OffsetValueType	OffsetValueType

typedef LabelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef Superclass::PointType	PointType

typedef Superclass::RegionType	RegionType

typedef LabelMap	Self

typedef Superclass::SizeType	SizeType

typedef Superclass::SizeValueType	SizeValueType

typedef Superclass::SpacingType	SpacingType

typedef ImageBase < TLabelObject::ImageDimension >	Superclass

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

typedef Matrix < SpacePrecisionType, VImageDimension, VImageDimension >	DirectionType

typedef unsigned int	ImageDimensionType

typedef Index< VImageDimension >	IndexType

typedef IndexType::IndexValueType	IndexValueType

typedef Offset< VImageDimension >	OffsetType

typedef OffsetType::OffsetValueType	OffsetValueType

typedef SmartPointer< Self >	Pointer

typedef Point< PointValueType, VImageDimension >	PointType

typedef SpacePrecisionType	PointValueType

typedef ImageRegion < VImageDimension >	RegionType

typedef ImageBase	Self

typedef Size< VImageDimension >	SizeType

typedef SizeType::SizeValueType	SizeValueType

typedef Vector < SpacingValueType, VImageDimension >	SpacingType

typedef SpacePrecisionType	SpacingValueType

typedef DataObject	Superclass

Public Member Functions
void	AddLabelObject (LabelObjectType *labelObject)

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

virtual 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

virtual 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

virtual 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

virtual void	Graft (const Self *data)

virtual 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)

virtual void	SetRequestedRegion (const DataObject *data) override

virtual 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

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

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

virtual void	UpdateOutputData () override

virtual void	UpdateOutputInformation () override

virtual 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])

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)

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 Attributes
static const unsigned int	ImageDimension = LabelObjectType::ImageDimension

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

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

	LabelMap ()

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

virtual	~LabelMap ()

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

void	ComputeOffsetTable ()

	ImageBase ()

virtual void	InitializeBufferedRegion ()

	~ImageBase ()

OffsetValueType	FastComputeOffset (const IndexType &ind) const

IndexType	FastComputeIndex (OffsetValueType offset) const

Private Types
typedef LabelObjectContainerType::const_iterator	LabelObjectContainerConstIterator

typedef LabelObjectContainerType::iterator	LabelObjectContainerIterator

typedef std::map< LabelType, LabelObjectPointerType >	LabelObjectContainerType

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