niftkContourTool.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef niftkContourTool_h
#define niftkContourTool_h

#include "niftkMIDASExports.h"

#include <mitkContourModel.h>
#include <mitkContourModelSet.h>
#include <mitkMessage.h>
#include <mitkOperation.h>
#include <mitkOperationActor.h>

#include <niftkPointUtils.h>

#include "niftkContourToolEventInterface.h"
#include "niftkTool.h"

namespace niftk
{

class NIFTKMIDAS_EXPORT ContourTool : public Tool {

public:

  mitkClassMacro(ContourTool, Tool)

  
  static const std::string EDITING_PROPERTY_NAME;

  static const std::string MIDAS_CONTOUR_TOOL_BACKGROUND_CONTOUR;

  virtual void ExecuteOperation(mitk::Operation* operation);

  virtual void ClearData();

  virtual mitk::ContourModel* GetContour();

  virtual void SetFeedbackContourVisible(bool);

  static void CopyContour(mitk::ContourModel &a, mitk::ContourModel &b);

  static void CopyContourSet(mitk::ContourModelSet &a, mitk::ContourModelSet &b, bool initialise=true);

  static void InitialiseContour(mitk::ContourModel &a, mitk::ContourModel &b);

  mitk::Message<> ContoursHaveChanged;

protected:

  ContourTool(); // purposely hidden
  virtual ~ContourTool(); // purposely hidden

  virtual bool OnMousePressed(mitk::StateMachineAction* action, mitk::InteractionEvent* event);

  void Disable3dRenderingOfNode(mitk::DataNode* node);

  void AccumulateContourInWorkingData(mitk::ContourModel& contour, int contourIndex);

  // Utility methods for helping draw lines that require m_Geometry to be set.
  void ConvertPointInMmToVx(const mitk::Point3D& pointInMm, mitk::Point3D& pointInVx);
  void ConvertPointToNearestVoxelCentreInVx(const mitk::Point3D& pointInMm, mitk::Point3D& nearestVoxelCentreInVx);
  void ConvertPointToNearestVoxelCentreInMm(const mitk::Point3D& pointInMm, mitk::Point3D& nearestVoxelCentreInMm);
  void GetClosestCornerPoint2D(const mitk::Point3D& pointInMm, int* whichTwoAxesInVx, mitk::Point3D& cornerPointInMm);

  int GetEqualCoordinateAxes(const mitk::Point3D& cornerPoint1InMm, const mitk::Point3D& cornerPoint2InMm, int* whichTwoAxesInVx);

  void GetAdditionalCornerPoint(const mitk::Point3D& cornerPoint1InMm, const mitk::Point3D& point2InMm, const mitk::Point3D& cornerPoint2InMm, int* whichTwoAxesInVx, mitk::Point3D& newCornerPointInMm);

  // Main method for drawing a line:
  //   1.) from previousPoint to currentPoint working around voxel corners, output in contourAroundCorners
  //   2.) from previousPoint to currentPoint working in a straight line, output in contourAlongLine
  // Returns true if new points added to contourAroundCorners or the last point updated, otherwise false.
  bool DrawLineAroundVoxelEdges(
      const mitk::Image* image,                 // input
      const mitk::BaseGeometry* geometry,       // input
      const mitk::PlaneGeometry* planeGeometry, // input
      const mitk::Point3D& currentPoint,        // input
      const mitk::Point3D& previousPoint,       // input
      mitk::ContourModel& contourAroundCorners,      // output
      mitk::ContourModel& contourAlongLine           // output
      );

  // Methods for manipulating the "BackgroundContour", which typically doesn't get drawn, but is useful for converting to image coordinates, e.g. for rendering into images for boundaries.
  mitk::ContourModel* GetBackgroundContour();
  void SetBackgroundContour(mitk::ContourModel&);
  void Disable3dRenderingOfBackgroundContour();
  void SetBackgroundContourVisible(bool);
  void SetBackgroundContourColor( float r, float g, float b );
  void SetBackgroundContourColorDefault();

  // We default this to 1, and use throughout.
  int m_ContourWidth;

  // We default this to false, and use throughout.
  bool m_ContourClosed;

  // We default this to 0.01, and use throughout when comparing point positions.
  float m_Tolerance;

  // This is the 3D geometry associated with the m_WorkingImage
  mitk::BaseGeometry* m_SegmentationImageGeometry;

  // This is the current 3D working image (the image that is the segmentation, i.e. a binary image)
  mitk::Image* m_SegmentationImage;

  // This is the current 3D reference image (the image that is being segmented, i.e. a grey scale image)
  mitk::Image* m_ReferenceImage;

  // Like the base class mitkFeedbackContourTool, we keep a contour that is the straight line, exaclty as we iterate, not working around voxel corners.
  mitk::ContourModel::Pointer  m_BackgroundContour;
  mitk::DataNode::Pointer m_BackgroundContourNode;
  bool                    m_BackgroundContourVisible;

private:

  // Operation constant, used in Undo/Redo framework.
  static const mitk::OperationType MIDAS_CONTOUR_TOOL_OP_ACCUMULATE_CONTOUR;

  ContourToolEventInterface::Pointer m_Interface;

};

}

#endif