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 <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;

    typedef std::map<PixelType, Label::Pointer> LabelContainerType;
    typedef LabelContainerType::const_iterator LabelContainerConstIteratorType;
    typedef LabelContainerType::iterator LabelContainerIteratorType;

    Message<> AddLabelEvent;

    Message<> RemoveLabelEvent;

    Message<> ModifyLabelEvent;

    Message1<PixelType> ActiveLabelEvent;

    Message<> AllLabelsModifiedEvent;

    LabelContainerConstIteratorType IteratorConstBegin() const;

    LabelContainerConstIteratorType IteratorConstEnd() const;

    LabelContainerIteratorType IteratorBegin();

    LabelContainerIteratorType IteratorEnd();

    void OnLabelModified();

    void SetLayer(unsigned int);

    void SetActiveLabel(PixelType);

    void RemoveLabel(PixelType);

    bool ExistLabel(PixelType);

    void AddLabel(mitk::Label *label);

    void 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);

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

} // namespace mitk

#endif // __mitkLabelSet_H_