mitkLabelSet.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkLabelSet_h
#define mitkLabelSet_h
 
#include "MitkMultilabelExports.h"
#include <mitkLookupTable.h>
#include <mitkMessage.h>
 
#include <itkObject.h>
#include <itkObjectFactory.h>
#include <itkEventObject.h>
 
#include <mitkLabel.h>
 
namespace mitk
{
  //
  // Documentation
  // @brief LabelSet containing the labels corresponding to a segmentation session.
  // @ingroup Data
  //
 
  class MITKMULTILABEL_EXPORT LabelSet : public itk::Object
  {
  public:
    mitkClassMacroItkParent(LabelSet, itk::Object);
    itkNewMacro(Self);
 
    typedef mitk::Label::PixelType PixelType;
 
    using LabelValueType = mitk::Label::PixelType;
    typedef std::map<LabelValueType, Label::Pointer> LabelContainerType;
    typedef LabelContainerType::const_iterator LabelContainerConstIteratorType;
    typedef LabelContainerType::iterator LabelContainerIteratorType;
 
    Message1<LabelValueType> AddLabelEvent;
 
    Message1<LabelValueType> RemoveLabelEvent;
 
    Message1<LabelValueType> ModifyLabelEvent;
 
    Message1<PixelType> ActiveLabelEvent;
 
    Message<> AllLabelsModifiedEvent;
 
    LabelContainerConstIteratorType IteratorConstBegin() const;
 
    LabelContainerConstIteratorType IteratorConstEnd() const;
 
    LabelContainerIteratorType IteratorBegin();
 
    LabelContainerIteratorType IteratorEnd();
 
    void OnLabelModified(const Object*, const itk::EventObject&);
 
    void SetLayer(unsigned int);
 
    void SetActiveLabel(PixelType);
 
    void RemoveLabel(PixelType);
 
    bool ExistLabel(PixelType);
 
    mitk::Label* AddLabel(mitk::Label *label, bool addAsClone = true);
 
    mitk::Label* AddLabel(const std::string &name, const Color &color);
 
    void RenameLabel(PixelType, const std::string &, const Color &);
 
    unsigned int GetNumberOfLabels() const;
 
    void SetAllLabelsVisible(bool);
 
    void SetAllLabelsLocked(bool);
 
    void RemoveAllLabels();
 
    void SetNextActiveLabel();
 
    Label *GetActiveLabel() { return GetLabel(m_ActiveLabelValue); }
    const Label *GetActiveLabel() const { return GetLabel(m_ActiveLabelValue); }
    Label *GetLabel(PixelType pixelValue);
 
    const Label *GetLabel(PixelType pixelValue) const;
 
    itkGetMacro(Layer, int);
 
    itkGetConstMacro(Layer, int);
 
    itkGetModifiableObjectMacro(LookupTable, mitk::LookupTable);
 
      void SetLookupTable(LookupTable *lut);
 
    void UpdateLookupTable(PixelType pixelValue);
 
    using ReservedLabelValuesFunctor = std::function<std::vector<LabelValueType>()>;
    ReservedLabelValuesFunctor m_ReservedLabelValuesFunctor;
 
    std::vector<LabelValueType> GetUsedLabelValues() const;
 
  protected:
    LabelSet();
    LabelSet(const LabelSet &);
 
    mitkCloneMacro(Self);
 
    ~LabelSet() override;
 
    void PrintSelf(std::ostream &os, itk::Indent indent) const override;
 
    LabelContainerType m_LabelContainer;
 
    LookupTable::Pointer m_LookupTable;
 
    PixelType m_ActiveLabelValue;
 
    unsigned int m_Layer;
  };
 
  MITKMULTILABEL_EXPORT bool Equal(const mitk::LabelSet &leftHandSide,
                                   const mitk::LabelSet &rightHandSide,
                                   ScalarType eps,
                                   bool verbose);
 
  MITKMULTILABEL_EXPORT LabelSet::Pointer GenerateLabelSetWithMappedValues(const LabelSet* sourceLabelSet,
    std::vector<std::pair<Label::PixelType, Label::PixelType> > labelMapping = { {1,1} });
 
} // namespace mitk
 
#endif