itkLabelMap.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLabelMap.h,v $
  Language:  C++
  Date:      $Date: 2009-05-14 21:08:43 $
  Version:   $Revision: 1.3 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkLabelMap_h
#define __itkLabelMap_h

#include "itkImageBase.h"
#include "itkImageRegion.h"
#include "itkFixedArray.h"
#include "itkWeakPointer.h"
#include <map>

namespace itk
{
template <class TLabelObject >
class ITK_EXPORT LabelMap : public ImageBase< ::itk::GetImageDimension<TLabelObject>::ImageDimension>
{
public:
  typedef LabelMap                                 Self;
  typedef ImageBase< ::itk::GetImageDimension<TLabelObject>::ImageDimension>
                                                   Superclass;
  typedef SmartPointer<Self>                       Pointer;
  typedef SmartPointer<const Self>                 ConstPointer;
  typedef WeakPointer<const Self>                  ConstWeakPointer;

  itkNewMacro(Self);

  itkTypeMacro(LabelMap, ImageBase);

  typedef TLabelObject LabelObjectType;

  typedef typename LabelObjectType::Pointer LabelObjectPointerType;

  itkStaticConstMacro(ImageDimension, unsigned int, LabelObjectType::ImageDimension);

  typedef typename LabelObjectType::LabelType  LabelType;
  typedef LabelType                            PixelType;

  typedef std::map< LabelType, LabelObjectPointerType > LabelObjectContainerType;

  typedef std::vector< LabelType >              LabelVectorType;
  typedef std::vector< LabelObjectPointerType > LabelObjectVectorType;

  typedef typename Superclass::IndexType  IndexType;

  typedef typename Superclass::OffsetType OffsetType;

  typedef typename Superclass::SizeType  SizeType;

  typedef typename Superclass::DirectionType  DirectionType;

  typedef typename Superclass::RegionType  RegionType;

  typedef typename Superclass::SpacingType SpacingType;

  typedef typename Superclass::PointType PointType;

  typedef typename Superclass::OffsetValueType OffsetValueType;

  void SetRegions( const RegionType & region )
    {
    this->SetLargestPossibleRegion(region);
    this->SetBufferedRegion(region);
    this->SetRequestedRegion(region);
    }

  void SetRegions( const SizeType & size )
    {
    RegionType region; region.SetSize(size);
    this->SetLargestPossibleRegion(region);
    this->SetBufferedRegion(region);
    this->SetRequestedRegion(region);
    }

  virtual void Initialize();

  virtual void Allocate();

  virtual void Graft(const DataObject *data);

  LabelObjectType * GetLabelObject( const LabelType & label );

  const LabelObjectType * GetLabelObject( const LabelType & label ) const;

  bool HasLabel( const LabelType label ) const;

  LabelObjectType * GetNthLabelObject( const unsigned long & pos );

  const LabelObjectType * GetNthLabelObject( const unsigned long & pos ) const;

  const LabelType & GetPixel( const IndexType & idx ) const;

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

  void SetLine( const IndexType & idx, const unsigned long & length, const LabelType & label );

  LabelObjectType * GetLabelObject( const IndexType & idx ) const;

  void AddLabelObject( LabelObjectType * labelObject );

  void PushLabelObject( LabelObjectType * labelObject );

  void RemoveLabelObject( LabelObjectType * labelObject );

  void RemoveLabel( const LabelType & label );

  void ClearLabels();

  const LabelObjectContainerType & GetLabelObjectContainer() const;
  LabelObjectContainerType & GetLabelObjectContainer();

  unsigned long GetNumberOfLabelObjects() const;

  LabelVectorType GetLabels() const;

  LabelObjectVectorType GetLabelObjects() const;

  itkGetConstMacro(BackgroundValue, LabelType);
  itkSetMacro(BackgroundValue, LabelType);

  void PrintLabelObjects(std::ostream& os) const;
  void PrintLabelObjects() const
    {
    this->PrintLabelObjects( std::cerr );
    }

protected:
  LabelMap();
  virtual ~LabelMap() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

private:
  LabelMap(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  LabelObjectContainerType m_LabelObjectContainer;
  LabelType                m_BackgroundValue;
};

} // end namespace itk


#ifndef ITK_MANUAL_INSTANTIATION
# include "itkLabelMap.txx"
#endif

#endif