mitkSegTool2D.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 mitkSegTool2D_h
#define mitkSegTool2D_h
 
#include <mitkCommon.h>
#include <mitkImage.h>
#include <mitkTool.h>
#include <MitkSegmentationExports.h>
 
#include <mitkInteractionPositionEvent.h>
 
#include <mitkInteractionConst.h>
#include <mitkPlanePositionManager.h>
#include <mitkRestorePlanePositionOperation.h>
 
#include <mitkSegSliceOperation.h>
 
#include <usModuleResource.h>
 
namespace mitk
{
  class BaseRenderer;
 
  class MITKSEGMENTATION_EXPORT SegTool2D : public Tool
  {
  public:
    mitkClassMacro(SegTool2D, Tool);
 
    static bool DetermineAffectedImageSlice(const Image *image,
                                            const PlaneGeometry *plane,
                                            int &affectedDimension,
                                            int &affectedSlice);
 
    static void UpdateAllSurfaceInterpolations(const MultiLabelSegmentation* workingImage,
                                           TimeStepType timeStep,
                                           const PlaneGeometry *plane,
                                           bool detectIntersection);
 
    static Image::Pointer GetAffectedImageSliceAs2DImage(const InteractionPositionEvent* positionEvent, const Image* image, unsigned int component = 0);
 
    static Image::Pointer GetAffectedImageSliceAs2DImage(const PlaneGeometry* planeGeometry,
      const Image* image,
      TimeStepType timeStep,
      unsigned int component = 0);
    static Image::Pointer GetAffectedImageSliceAs2DImageByTimePoint(const PlaneGeometry* planeGeometry,
      const Image* image,
      TimePointType timePoint,
      unsigned int component = 0);
 
    static void WriteBackSegmentationResult(const DataNode* workingNode, const PlaneGeometry* planeGeometry, const Image* segmentationResult, TimeStepType timeStep, const std::string& toolName);
 
    static void WriteSliceToVolume(Image* workingImage, const PlaneGeometry* planeGeometry, const Image* slice, TimeStepType timeStep);
 
    void SetShowMarkerNodes(bool show);
 
    void SetEnable3DInterpolation(bool);
 
    void Activated() override;
    void Deactivated() override;
 
    itkSetMacro(IsTimePointChangeAware, bool);
    itkGetMacro(IsTimePointChangeAware, bool);
    itkBooleanMacro(IsTimePointChangeAware);
 
    DataNode* GetWorkingDataNode() const;
 
    MultiLabelSegmentation* GetWorkingData() const;
 
    DataNode* GetReferenceDataNode() const;
 
    Image* GetReferenceData() const;
 
  protected:
    SegTool2D();             // purposely hidden
    SegTool2D(const char *, const us::Module *interactorModule = nullptr); // purposely hidden
    ~SegTool2D() override;
 
    virtual void OnTimePointChanged();
 
    struct SliceInformation
    {
      mitk::Image::ConstPointer slice;
      const mitk::PlaneGeometry *plane = nullptr;
      mitk::TimeStepType timestep = 0;
      unsigned int slicePosition;
 
      SliceInformation() = default;
      SliceInformation(const mitk::Image* aSlice, const mitk::PlaneGeometry* aPlane, mitk::TimeStepType aTimestep);
    };
 
    static void UpdateSurfaceInterpolation(const std::vector<SliceInformation>& sliceInfos,
      const Image* workingImage,
      bool detectIntersection,
      mitk::Label::PixelType activeLabelValue, bool silent = false);
 
 
    bool FilterEvents(InteractionEvent *interactionEvent, DataNode *dataNode) override;
 
    Image::Pointer GetAffectedWorkingSlice(const InteractionPositionEvent *) const;
 
    Image::Pointer GetAffectedReferenceSlice(const InteractionPositionEvent *) const;
    Image::Pointer GetAffectedReferenceSlice(const PlaneGeometry* planeGeometry, TimeStepType timeStep) const;
 
    void WriteBackSegmentationResult(const InteractionPositionEvent *, const Image* segmentationResult);
 
    void WriteBackSegmentationResult(const PlaneGeometry *planeGeometry, const Image* segmentationResult, TimeStepType timeStep);
 
    void WriteBackSegmentationResults(const std::vector<SliceInformation> &sliceList, bool writeSliceToVolume = true);
 
    static void WriteBackSegmentationResults(const DataNode* workingNode, const std::vector<SliceInformation>& sliceList, bool writeSliceToVolume = true, bool allowUndo = true, const std::string& toolName = "");
 
    virtual MultiLabelSegmentation::LabelValueVectorType GetAffectedLabelValues() const;
 
    static void WriteSliceToVolume(Image* workingImage, const SliceInformation &sliceInfo);
 
    int AddContourmarker(const PlaneGeometry* planeGeometry, unsigned int sliceIndex);
    void DisableContourMarkers();
 
    void InteractiveSegmentationBugMessage(const std::string &message) const;
 
    static bool IsPositionEventInsideImageRegion(InteractionPositionEvent* positionEvent, const BaseData* data);
 
    BaseRenderer *m_LastEventSender = nullptr;
    unsigned int m_LastEventSlice = 0;
 
    itkGetMacro(LastTimePointTriggered, TimePointType);
 
    void PushCursor();
 
    void PushCursor(us::ModuleResource cursorResource);
 
    void PopCursor(bool popFirstCursor = false);
 
    void PopAllCursors();
 
  private:
    void OnTimePointChangedInternal();
 
    static void  RemoveContourFromInterpolator(const SliceInformation& sliceInfo, MultiLabelSegmentation::LabelValueType labelValue);
 
    // The prefix of the contourmarkername. Suffix is a consecutive number
    const std::string m_Contourmarkername;
    bool m_EnableContourMarkers = true;
    bool m_ShowMarkerNodes = false;
    static bool m_SurfaceInterpolationEnabled;
 
    bool m_IsTimePointChangeAware = true;
 
    TimePointType m_LastTimePointTriggered = 0.;
 
    unsigned int m_NumPushedCursors = 0;
  };
 
} // namespace
 
#endif