QmitkMultiLabelInspector.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 QmitkMultiLabelInspector_h
#define QmitkMultiLabelInspector_h
 
#include <MitkSegmentationUIExports.h>
#include <mitkWeakPointer.h>
#include <mitkLabelSetImage.h>
#include <mitkDataNode.h>
#include <mitkLabelHighlightGuard.h>
#include <mitkLabelSuggestionHelper.h>
 
#include <QWidget>
#include <QItemSelectionModel>
 
class QmitkMultiLabelTreeModel;
class QStyledItemDelegate;
class QWidgetAction;
class QCompleter;
 
namespace Ui
{
  class QmitkMultiLabelInspector;
}
 
/*
* @brief This is an inspector that offers a tree view on the labels and groups of a MultiLabelSegmentation instance.
* It also allows some manipulation operations an the labels/groups according to the UI/selection state.
*/
class MITKSEGMENTATIONUI_EXPORT QmitkMultiLabelInspector : public QWidget
{
  Q_OBJECT
 
public:
  QmitkMultiLabelInspector(QWidget* parent = nullptr);
 
  ~QmitkMultiLabelInspector();
 
  bool GetMultiSelectionMode() const;
 
  bool GetAllowVisibilityModification() const;
  bool GetAllowLockModification() const;
  bool GetAllowLabelModification() const;
  bool GetModelManipulationOngoing() const;
 
  using LabelValueType = mitk::MultiLabelSegmentation::LabelValueType;
  using LabelValueVectorType = mitk::MultiLabelSegmentation::LabelValueVectorType;
 
  LabelValueVectorType GetSelectedLabels() const;
 
  mitk::Label* GetCurrentLabel() const;
 
  enum class IndexLevelType
  {
    Group,
    LabelClass,
    LabelInstance
  };
 
  IndexLevelType GetCurrentLevelType() const;
 
  LabelValueVectorType GetCurrentlyAffactedLabelInstances() const;
 
  LabelValueVectorType GetLabelInstancesOfSelectedFirstLabel() const;
 
  const mitk::LabelSuggestionHelper* GetLabelSuggestionHelper() const;
 
Q_SIGNALS:
  void CurrentSelectionChanged(LabelValueVectorType labels) const;
 
  void GoToLabel(LabelValueType label, const mitk::Point3D& point) const;
 
  void LabelRenameRequested(mitk::Label* label, bool rename, bool& canceled) const;
 
  void ModelUpdated() const;
 
  void SegmentationChanged() const;
 
public Q_SLOTS:
 
  void SetSelectedLabels(const LabelValueVectorType& selectedLabels);
  void SetSelectedLabel(mitk::MultiLabelSegmentation::LabelValueType selectedLabel);
 
  void SetMultiLabelSegmentation(mitk::MultiLabelSegmentation* segmentation);
  mitk::MultiLabelSegmentation* GetMultiLabelSegmentation() const;
 
  void SetMultiLabelNode(mitk::DataNode* node);
  mitk::DataNode* GetMultiLabelNode() const;
 
  void SetMultiSelectionMode(bool multiMode);
 
  void SetAllowVisibilityModification(bool visiblityMod);
  void SetAllowLockModification(bool lockMod);
  void SetAllowLabelModification(bool labelMod);
 
  void SetDefaultLabelNaming(bool defaultLabelNaming);
 
  void SetLabelSuggestionHelper(const mitk::LabelSuggestionHelper* suggestionHelper);
 
  mitk::Label* AddNewLabelInstance();
 
  mitk::Label* AddNewLabel();
 
  void DeleteLabelInstance();
 
  void DeleteLabel();
 
  mitk::Label* AddNewGroup();
 
  void RemoveGroup();
 
  void OnCopyToGroup();
 
  void SetVisibilityOfAffectedLabels(bool visible) const;
  void SetLockOfAffectedLabels(bool visible) const;
 
protected Q_SLOTS:
  void OnModelReset();
  void OnModelChanged();
  void OnDataChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight,
    const QList<int>& roles = QList<int>());
 
protected:
  void Initialize();
 
  QmitkMultiLabelTreeModel* m_Model;
  mitk::MultiLabelSegmentation::Pointer m_Segmentation;
 
  LabelValueVectorType m_LastValidSelectedLabels;
  QStyledItemDelegate* m_LockItemDelegate;
  QStyledItemDelegate* m_ColorItemDelegate;
  QStyledItemDelegate* m_VisibilityItemDelegate;
 
  Ui::QmitkMultiLabelInspector* m_Controls;
 
  LabelValueVectorType GetSelectedLabelsFromSelectionModel() const;
  void UpdateSelectionModel(const LabelValueVectorType& selectedLabels);
 
  mitk::Label* GetFirstSelectedLabelObject() const;
 
  mitk::Label* AddNewLabelInternal(const mitk::MultiLabelSegmentation::GroupIndexType& containingGroup);
 
  mitk::Label* AddNewLabelInstanceInternal(mitk::Label* templateLabel);
 
  void RemoveGroupInternal(const mitk::MultiLabelSegmentation::GroupIndexType& groupID);
  void DeleteLabelInternal(const LabelValueVectorType& labelValues);
 
  void keyPressEvent(QKeyEvent* event) override;
  void keyReleaseEvent(QKeyEvent* event) override;
 
private Q_SLOTS:
  void OnChangeModelSelection(const QItemSelection& selected, const QItemSelection& deselected);
 
  void OnContextMenuRequested(const QPoint&);
 
  void OnAddLabel();
  void OnAddLabelInstance();
  void OnDeleteGroup();
  void OnDeleteAffectedLabel();
  void OnDeleteLabels(bool);
  void OnClearLabels(bool);
  void OnMergeLabels(bool);
 
  void OnRenameGroup();
  void OnRenameLabel(bool);
  void OnClearLabel(bool);
 
  void OnUnlockAffectedLabels();
  void OnLockAffectedLabels();
 
  void OnSetAffectedLabelsVisible();
  void OnSetAffectedLabelsInvisible();
  void OnSetOnlyActiveLabelVisible(bool);
 
  void OnItemDoubleClicked(const QModelIndex& index);
 
  void WaitCursorOn() const;
  void WaitCursorOff() const;
  void RestoreOverrideCursor() const;
 
  void PrepareGoToLabel(LabelValueType labelID) const;
 
  void OnEntered(const QModelIndex& index);
  void OnMouseLeave();
 
  void OnSearchLabel();
  void RefreshCompleter();
 
  QWidgetAction* CreateOpacityAction();
 
private:
  bool m_ShowVisibility = true;
  bool m_ShowLock = true;
  bool m_ShowOther = false;
 
  bool m_AllowVisibilityModification = true;
 
  bool m_AllowLockModification = true;
 
  bool m_AllowLabelModification = false;
 
  bool m_DefaultLabelNaming = true;
 
  bool m_ModelManipulationOngoing = false;
 
  bool m_AboutToShowContextMenu = false;
 
  bool m_CheckSelectionDueToExternalModelChange = true;
 
  mitk::DataNode::Pointer m_SegmentationNode;
  unsigned long m_SegmentationNodeDataMTime;
  mitk::ITKEventObserverGuard m_SegmentationObserver;
  mitk::LabelHighlightGuard m_LabelHighlightGuard;
  mitk::LabelSuggestionHelper::ConstPointer m_SuggestionHelper;
  mitk::ITKEventObserverGuard m_SuggestionObserver;
 
  QCompleter* m_Completer;
};
 
#endif