![]() |
ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkLabelMap.h>
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:
This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176
Definition at line 70 of file itkLabelMap.h.
Classes | |
class | ConstIterator |
A forward iterator over the LabelObjects of a LabelMap. More... | |
class | Iterator |
A forward iterator over the LabelObjects of a LabelMap. More... | |
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 |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef Matrix< double, VImageDimension, VImageDimension > | DirectionType |
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 double | PointValueType |
typedef ImageRegion < VImageDimension > | RegionType |
typedef ImageBase | Self |
typedef Size< VImageDimension > | SizeType |
typedef SizeType::SizeValueType | SizeValueType |
typedef Vector < SpacingValueType, VImageDimension > | SpacingType |
typedef double | SpacingValueType |
typedef DataObject | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef std::string | DataObjectIdentifierType |
typedef std::vector< Pointer > ::size_type | DataObjectPointerArraySizeType |
typedef SmartPointer< Self > | Pointer |
typedef DataObject | Self |
typedef Object | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
void | AddLabelObject (LabelObjectType *labelObject) |
void | AddPixel (const IndexType &idx, const LabelType &label) |
virtual void | Allocate () |
void | ClearLabels () |
virtual ::itk::LightObject::Pointer | CreateAnother (void) 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 DataObject *data) |
bool | HasLabel (const LabelType label) const |
virtual void | Initialize () |
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) |
![]() | |
OffsetValueType | ComputeOffset (const IndexType &ind) const |
virtual void | CopyInformation (const DataObject *data) |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual const RegionType & | GetBufferedRegion () const |
virtual const DirectionType & | GetDirection () |
virtual const DirectionType & | GetInverseDirection () |
virtual const RegionType & | GetLargestPossibleRegion () const |
virtual const PointType & | GetOrigin () |
virtual const RegionType & | GetRequestedRegion () const |
virtual const SpacingType & | GetSpacing () |
void | Initialize () |
virtual bool | RequestedRegionIsOutsideOfTheBufferedRegion () |
virtual void | SetBufferedRegion (const RegionType ®ion) |
virtual void | SetDirection (const DirectionType direction) |
virtual void | SetLargestPossibleRegion (const RegionType ®ion) |
virtual void | SetRegions (const SizeType &size) |
virtual void | SetRequestedRegion (const RegionType ®ion) |
virtual void | SetRequestedRegion (const DataObject *data) |
virtual void | SetRequestedRegionToLargestPossibleRegion () |
void | TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const |
bool | TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, 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 () |
virtual void | UpdateOutputInformation () |
virtual bool | VerifyRequestedRegion () |
virtual void | SetOrigin (PointType _arg) |
virtual void | SetOrigin (const double origin[VImageDimension]) |
virtual void | SetOrigin (const float origin[VImageDimension]) |
virtual void | SetRegions (const RegionType ®ion) |
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< TCoordRep, 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) |
![]() | |
virtual void | DataHasBeenGenerated () |
void | DisconnectPipeline () |
bool | GetDataReleased () const |
virtual const bool & | GetReleaseDataFlag () |
SmartPointerForwardReference < 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 () |
virtual void | SetRealTimeStamp (RealTimeStamp _arg) |
virtual const RealTimeStamp & | GetRealTimeStamp () |
![]() | |
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 (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 |
virtual void | Register () const |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const |
![]() | |
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 unsigned int | GetImageDimension () |
static Pointer | New () |
![]() | |
static bool | GetGlobalReleaseDataFlag () |
static void | GlobalReleaseDataFlagOff () |
static void | GlobalReleaseDataFlagOn () |
static void | SetGlobalReleaseDataFlag (bool val) |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static const unsigned int | ImageDimension = LabelObjectType::ImageDimension |
![]() | |
static const unsigned int | ImageDimension |
Protected Member Functions | |
LabelMap () | |
void | PrintSelf (std::ostream &os, Indent indent) const |
virtual | ~LabelMap () |
![]() | |
virtual void | ComputeIndexToPhysicalPointMatrices () |
void | ComputeOffsetTable () |
ImageBase () | |
virtual void | InitializeBufferedRegion (void) |
~ImageBase () | |
![]() | |
DataObject () | |
virtual void | PropagateResetPipeline () |
~DataObject () | |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
![]() | |
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 | |
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) |
LabelMap (const Self &) | |
void | operator= (const Self &) |
void | RemovePixel (const LabelObjectContainerIterator &it, const IndexType &idx, bool iEmitModifiedEvent) |
Private Attributes | |
LabelType | m_BackgroundValue |
LabelObjectContainerType | m_LabelObjectContainer |
Additional Inherited Members | |
![]() | |
typedef int | InternalReferenceCountType |
![]() | |
DirectionType | m_Direction |
DirectionType | m_IndexToPhysicalPoint |
DirectionType | m_InverseDirection |
PointType | m_Origin |
DirectionType | m_PhysicalPointToIndex |
SpacingType | m_Spacing |
typedef SmartPointer< const Self > itk::LabelMap< TLabelObject >::ConstPointer |
Definition at line 77 of file itkLabelMap.h.
typedef WeakPointer< const Self > itk::LabelMap< TLabelObject >::ConstWeakPointer |
Definition at line 78 of file itkLabelMap.h.
typedef Superclass::DirectionType itk::LabelMap< TLabelObject >::DirectionType |
Direction typedef support. A matrix of direction cosines.
Definition at line 117 of file itkLabelMap.h.
typedef Superclass::IndexType itk::LabelMap< TLabelObject >::IndexType |
Index typedef support. An index is used to access pixel values.
Definition at line 108 of file itkLabelMap.h.
|
private |
Definition at line 464 of file itkLabelMap.h.
|
private |
Definition at line 462 of file itkLabelMap.h.
|
private |
the LabelObject container type
Definition at line 461 of file itkLabelMap.h.
typedef LabelObjectType::Pointer itk::LabelMap< TLabelObject >::LabelObjectPointerType |
Definition at line 88 of file itkLabelMap.h.
typedef TLabelObject itk::LabelMap< TLabelObject >::LabelObjectType |
Definition at line 84 of file itkLabelMap.h.
typedef std::vector< LabelObjectPointerType > itk::LabelMap< TLabelObject >::LabelObjectVectorType |
Definition at line 105 of file itkLabelMap.h.
typedef LabelObjectType::LabelType itk::LabelMap< TLabelObject >::LabelType |
Label typedef support.
Definition at line 100 of file itkLabelMap.h.
typedef std::vector< LabelType > itk::LabelMap< TLabelObject >::LabelVectorType |
types used to expose labels only and label objects only
Definition at line 104 of file itkLabelMap.h.
typedef SizeValueType itk::LabelMap< TLabelObject >::LengthType |
Definition at line 91 of file itkLabelMap.h.
typedef Superclass::OffsetType itk::LabelMap< TLabelObject >::OffsetType |
Offset typedef support. An offset is used to access pixel values.
Definition at line 111 of file itkLabelMap.h.
typedef Superclass::OffsetValueType itk::LabelMap< TLabelObject >::OffsetValueType |
Offset typedef (relative position between indices)
Definition at line 132 of file itkLabelMap.h.
typedef LabelType itk::LabelMap< TLabelObject >::PixelType |
Definition at line 101 of file itkLabelMap.h.
typedef SmartPointer< Self > itk::LabelMap< TLabelObject >::Pointer |
Definition at line 76 of file itkLabelMap.h.
typedef Superclass::PointType itk::LabelMap< TLabelObject >::PointType |
Origin typedef support. The origin is the geometric coordinates of the index (0,0).
Definition at line 129 of file itkLabelMap.h.
typedef Superclass::RegionType itk::LabelMap< TLabelObject >::RegionType |
Region typedef support. A region is used to specify a subset of an image.
Definition at line 121 of file itkLabelMap.h.
typedef LabelMap itk::LabelMap< TLabelObject >::Self |
Standard class typedefs
Definition at line 74 of file itkLabelMap.h.
typedef Superclass::SizeType itk::LabelMap< TLabelObject >::SizeType |
Size typedef support. A size is used to define region bounds.
Definition at line 114 of file itkLabelMap.h.
typedef Superclass::SizeValueType itk::LabelMap< TLabelObject >::SizeValueType |
Definition at line 90 of file itkLabelMap.h.
typedef Superclass::SpacingType itk::LabelMap< TLabelObject >::SpacingType |
Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.
Definition at line 125 of file itkLabelMap.h.
typedef ImageBase< TLabelObject ::ImageDimension > itk::LabelMap< TLabelObject >::Superclass |
Definition at line 75 of file itkLabelMap.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 453 of file itkLabelMap.h.
|
private |
void itk::LabelMap< TLabelObject >::AddLabelObject | ( | LabelObjectType * | labelObject | ) |
Add a label object to the image. If a label object already has the label, it is overiden.
void itk::LabelMap< TLabelObject >::AddPixel | ( | const IndexType & | idx, |
const LabelType & | label | ||
) |
Add index idx
to the label object whose label is label
. If no label object has the label label
, the corresponding label object is created. The worst case complexity of this method is O(L) where L is the number of lines in the image. However, the execution time will be quite low if the pixels are set in the image in raster mode.
|
private |
|
virtual |
Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions() or SetBufferedRegion().
This method should be pure virtual, if backwards compatibility was not required.
Reimplemented from itk::ImageBase< TLabelObject::ImageDimension >.
void itk::LabelMap< TLabelObject >::ClearLabels | ( | ) |
Remove all the labels in the image
|
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.
|
virtual |
Set/Get the background label
LabelObjectType* itk::LabelMap< TLabelObject >::GetLabelObject | ( | const LabelType & | label | ) |
Return the LabelObject with the label given in parameter. This method thorws an exception if the label doesn't exist in this image, or if the label is the background one.
const LabelObjectType* itk::LabelMap< TLabelObject >::GetLabelObject | ( | const LabelType & | label | ) | const |
Return the LabelObject with the label given in parameter. This method thorws an exception if the label doesn't exist in this image, or if the label is the background one.
LabelObjectType* itk::LabelMap< TLabelObject >::GetLabelObject | ( | const IndexType & | idx | ) | const |
Return the label object at a given index. This method has a worst case complexity of O(L) where L is the number of lines in the image - use it with care.
LabelObjectVectorType itk::LabelMap< TLabelObject >::GetLabelObjects | ( | ) | const |
Return the the label objects available in the label map
LabelVectorType itk::LabelMap< TLabelObject >::GetLabels | ( | ) | const |
Return the labels of the label objects available in the label map
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageBase< TLabelObject::ImageDimension >.
LabelObjectType* itk::LabelMap< TLabelObject >::GetNthLabelObject | ( | const SizeValueType & | pos | ) |
Return the LabelObject with at the position given in parameter. This method can be useful when the labels are not consecutives, but is quite inefficient. This method thorws an exception if the index doesn't exist in this image.
const LabelObjectType* itk::LabelMap< TLabelObject >::GetNthLabelObject | ( | const SizeValueType & | pos | ) | const |
Return the LabelObject with at the position given in parameter. This method can be useful when the labels are not consecutives, but is quite inefficient. This method thorws an exception if the index doesn't exist in this image.
Self::SizeValueType itk::LabelMap< TLabelObject >::GetNumberOfLabelObjects | ( | ) | const |
Return the numbner of label objects in the image
const LabelType& itk::LabelMap< TLabelObject >::GetPixel | ( | const IndexType & | idx | ) | const |
Return the pixel value at a given index in the image. If the given index is contained in several objects, only the smallest label of those objects is returned. This method has a worst case complexity of O(L) where L is the number of lines in the image - use it with care.
|
virtual |
Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. Subclasses of ImageBase are responsible for copying the pixel container.
Reimplemented from itk::ImageBase< TLabelObject::ImageDimension >.
bool itk::LabelMap< TLabelObject >::HasLabel | ( | const LabelType | label | ) | const |
Return true is the image contains the label given in parameter and false otherwise. If the label is the background one, true is also returned, so this method may not be a good enough test before calling GetLabelObject().
|
virtual |
Restore the data object to its initial state. This means releasing memory.
Reimplemented from itk::DataObject.
|
static |
Method for creation through the object factory.
|
private |
void itk::LabelMap< TLabelObject >::Optimize | ( | ) |
Optimize the line representation of all the lable objects referenced in the LabelMap
void itk::LabelMap< TLabelObject >::PrintLabelObjects | ( | std::ostream & | os | ) | const |
Print all the objects stored in that collection - a convenient method for prototyping.
|
inline |
Definition at line 275 of file itkLabelMap.h.
|
protectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::ImageBase< TLabelObject::ImageDimension >.
void itk::LabelMap< TLabelObject >::PushLabelObject | ( | LabelObjectType * | labelObject | ) |
Add a label object to the image. The label of the label object is ignored, and a new label is given to the label object.
void itk::LabelMap< TLabelObject >::RemoveLabel | ( | const LabelType & | label | ) |
Remove a label object.
void itk::LabelMap< TLabelObject >::RemoveLabelObject | ( | LabelObjectType * | labelObject | ) |
Remove a label object.
void itk::LabelMap< TLabelObject >::RemovePixel | ( | const IndexType & | idx, |
const LabelType & | label | ||
) |
Remove index idx
from the label object which has the label label
. If the label object gets empty, it is being removed from the container.
|
private |
|
virtual |
Set/Get the background label
void itk::LabelMap< TLabelObject >::SetLine | ( | const IndexType & | idx, |
const LengthType & | length, | ||
const LabelType & | label | ||
) |
Set a full line in the image. If no label object has this label in the image, a new object is created. If a label object already exist with that label, the line is added to it WITHOUT any check - it means that if the label object may contain several time the same pixel after have run that method. This method runs in constant time.
void itk::LabelMap< TLabelObject >::SetPixel | ( | const IndexType & | idx, |
const LabelType & | label | ||
) |
Set the pixel value at a given index in the image.
As for itk::Image, this method ensure that the pixel at the position idx
has a unique value.
The complexity of this method is at best O(L) where L is the number of lines in the image - usit with care.
|
static |
Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.
Definition at line 97 of file itkLabelMap.h.
|
private |
Definition at line 467 of file itkLabelMap.h.
|
private |
Definition at line 466 of file itkLabelMap.h.