QmitknnInteractiveToolGUI.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 QmitknnInteractiveToolGUI_h
#define QmitknnInteractiveToolGUI_h
 
#include <QmitkSegWithPreviewToolGUIBase.h>
#include <mitkIPreferences.h>
#include <mitkLabelSetImage.h>
#include <mitknnInteractiveTool.h>
#include <mitkWeakPointer.h>
#include <MitkPythonSegmentationUIExports.h>
 
#include <QString>
 
#include <memory>
#include <optional>
#include <vector>
 
class QAbstractButton;
class QButtonGroup;
class QPushButton;
class QTimer;
 
namespace mitk::nnInteractive
{
  struct VersionCheckResult;
}
 
namespace Ui
{
  class QmitknnInteractiveToolGUI;
}
 
class MITKPYTHONSEGMENTATIONUI_EXPORT QmitknnInteractiveToolGUI : public QmitkSegWithPreviewToolGUIBase
{
  Q_OBJECT
 
public:
  mitkClassMacro(QmitknnInteractiveToolGUI, QmitkSegWithPreviewToolGUIBase);
  itkFactorylessNewMacro(Self);
 
protected:
  using InteractionType = mitk::nnInteractive::InteractionType;
 
  using PromptType = mitk::nnInteractive::PromptType;
 
  QmitknnInteractiveToolGUI();
 
  ~QmitknnInteractiveToolGUI() override;
 
  void InitializeUI(QBoxLayout* mainLayout) override;
 
  void InitializePromptType();
 
  void InitializeInteractorButtons();
 
  void EnableInitializeButtons(bool enabled);
 
  void OnInitializeButtonToggled(bool checked);
 
  void OnSettingsButtonClicked();
 
  void OnResetInteractionsButtonClicked();
 
  void OnUndoButtonClicked();
 
  void OnAutoRefineCheckBoxToggled(bool checked);
 
  void OnAutoZoomCheckBoxToggled(bool checked);
 
  void OnPromptTypeChanged();
 
  void OnInteractorToggled(mitk::nnInteractive::InteractionType interactionType, bool checked);
 
  void OnActiveLabelChanged(const mitk::MultiLabelSegmentation::LabelValueVectorType& labels);
 
  void OnConfirmCleanUp(bool isConfirmed);
 
  void OnPreviewUpdated();
 
  void OnToolDeactivated();
 
  void OnSessionEnded();
 
  void OnSessionExpired();
 
  void OnHeartbeatTimeout();
 
  void UpdateModelLicenseDisplay(const std::optional<std::string>& license);
 
  mitk::nnInteractiveTool* GetTool();
 
  void UncheckOtherInteractorButtons(QPushButton* interactorButton);
 
  bool Install();
 
private:
  bool IsAutoCreateNextLabelEnabled() const;
 
  bool IsAutoConfirmEnabled() const;
 
  bool IsNamingPromptSkippedOnAutoCreate() const;
 
  bool AreShortcutsShownInLabels() const;
 
  void ApplyShortcutLabels();
 
  void OnPreferenceChangedEvent(const mitk::IPreferences::ChangeEvent& event);
 
  bool AutoCreateAndSelectNewLabel();
 
  void InvalidateAutoCreatedLabel();
 
  void OnAutoCreatedSegmentationDeleted();
 
  void ReEnableLastInteractor();
 
  void ApplyCapabilityGating();
 
  void UpdateUndoButtonState();
 
  void MaybeInitializeWithLabelMask(mitk::MultiLabelSegmentation::LabelValueType labelValue);
 
  void UpdateConfirmButtonLabel();
 
  void UpdateInitializeButtonText();
 
  void UncheckInitializeButton();
 
  bool OfferInPlaceUpdate(const mitk::nnInteractive::VersionCheckResult& versionCheck, bool clientOnly);
 
  bool RunUpdate(bool clientOnly);
 
  void MaybePromptModelSwitch(bool localAvailable);
 
  struct ShortcutLabel
  {
    QPushButton* button;
    Qt::Key key;
    QString baseText;
  };
 
  std::unique_ptr<Ui::QmitknnInteractiveToolGUI> m_Ui;
  QButtonGroup* m_PromptTypeButtonGroup;
  PromptType m_PromptType;
  std::unordered_map<InteractionType, QPushButton*> m_InteractorButtons;
 
  std::optional<mitk::MultiLabelSegmentation::LabelValueType> m_AutoCreatedLabelValue;
  std::optional<mitk::MultiLabelSegmentation::LabelValueType> m_PreviousActiveLabelValue;
  mitk::WeakPointer<mitk::MultiLabelSegmentation> m_AutoCreatedLabelSegmentation;
  QAbstractButton* m_LastInteractorButton = nullptr;
  bool m_AutoConfirmInProgress = false;
 
  // Set while AutoCreateAndSelectNewLabel() drives the inspector's selection.
  // The inspector emits CurrentSelectionChanged synchronously, which would
  // otherwise re-enter OnActiveLabelChanged and reset/re-seed the session
  // mid-confirm. The slot honours this guard and stays a no-op.
  bool m_SuppressActiveLabelChanged = false;
 
  // Whether the running session reports undo support (nnInteractive >= 2.3.3).
  // Cached at session start (ApplyCapabilityGating) and used to gate the Undo
  // button; older versions report no support and the button stays disabled.
  bool m_SupportsUndo = false;
 
  QTimer* m_HeartbeatTimer = nullptr;
 
  // Set when a lost remote session is being torn down so a second
  // SessionExpiredEvent (the tool emits it from both the heartbeat and a
  // mid-interaction failure) cannot queue a duplicate teardown/dialog. Cleared
  // in OnSessionEnded once teardown completes.
  bool m_SessionExpiredHandled = false;
 
  mitk::IPreferences* m_Preferences = nullptr;
  std::vector<ShortcutLabel> m_ShortcutLabels;
  QString m_PromptTypeBaseTitle;
  QString m_PreviewLabelBaseText;
};
 
#endif