niftkPaintbrushTool.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 niftkPaintbrushTool_h
#define niftkPaintbrushTool_h

#include "niftkMIDASExports.h"

#include <itkImage.h>

#include <mitkGeometry3D.h>
#include <mitkImage.h>
#include <mitkOperation.h>
#include <mitkOperationActor.h>
#include <mitkSegTool2D.h>

#include <usServiceReference.h>

#include <itkMIDASImageUpdatePixelWiseSingleValueProcessor.h>

#include "niftkPaintbrushToolOpEditImage.h"
#include "niftkPaintbrushToolEventInterface.h"
#include "niftkFilteringStateMachine.h"

namespace niftk
{

class NIFTKMIDAS_EXPORT PaintbrushTool : public mitk::SegTool2D, public FilteringStateMachine
{

public:

  enum
  {
    EROSIONS_ADDITIONS,
    EROSIONS_SUBTRACTIONS,
    DILATIONS_ADDITIONS,
    DILATIONS_SUBTRACTIONS
  };

  static const std::string EROSIONS_ADDITIONS_NAME;

  static const std::string EROSIONS_SUBTRACTIONS_NAME;

  static const std::string DILATIONS_ADDITIONS_NAME;

  static const std::string DILATIONS_SUBTRACTIONS_NAME;


  mitkClassMacro(PaintbrushTool, mitk::SegTool2D)
  itkNewMacro(PaintbrushTool)

  typedef itk::Image<mitk::Tool::DefaultSegmentationDataType, 3> ImageType;
  typedef itk::MIDASImageUpdatePixelWiseSingleValueProcessor<mitk::Tool::DefaultSegmentationDataType, 3> ProcessorType;

  virtual void InitializeStateMachine();

  virtual const char* GetName() const;
  virtual const char** GetXPM() const;

  static const std::string REGION_PROPERTY_NAME;

  int GetCursorSize() const;

  void SetCursorSize(int cursorSize);

  bool GetErosionMode() const;

  void SetErosionMode(bool erosionMode);

  mitk::Message1<int> CursorSizeChanged;

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

  virtual bool StartAddingAddition(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool KeepAddingAddition(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool StopAddingAddition(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool StartAddingSubtraction(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool KeepAddingSubtraction(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool StopAddingSubtraction(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool StartRemovingSubtraction(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool KeepRemovingSubtraction(mitk::StateMachineAction* action, mitk::InteractionEvent* event);
  virtual bool StopRemovingSubtraction(mitk::StateMachineAction* action, mitk::InteractionEvent* event);

  mitk::Message1<int> SegmentationEdited;

protected:

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

  virtual void ConnectActionsAndFunctions();

  bool FilterEvents(mitk::InteractionEvent* event, mitk::DataNode* dataNode);

  virtual void Activated();

  virtual void Deactivated();

private:

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

  void GetListOfAffectedVoxels(
      const mitk::PlaneGeometry& planeGeometry,
      mitk::Point3D& currentPoint,
      mitk::Point3D& previousPoint,
      ProcessorType &processor);

  bool MarkInitialPosition(unsigned int dataIndex, mitk::StateMachineAction* action, mitk::InteractionEvent* event);

  void SetInvalidRegion(unsigned int dataIndex);

  void SetValidRegion(unsigned int dataIndex, const std::vector<int>& boundingBox);

  void SetRegion(unsigned int dataIndex, bool valid, const std::vector<int>& boundingBox = std::vector<int>());

  bool DoMouseMoved(mitk::StateMachineAction* action, mitk::InteractionEvent* event,
      int dataIndex,
      unsigned char valueForRedo,
      unsigned char valueForUndo
      );

  template<typename TPixel, unsigned int VImageDimension>
  void RunITKProcessor(
      itk::Image<TPixel, VImageDimension>* itkImage,
      ProcessorType::Pointer processor,
      bool redo,
      unsigned char valueToWrite
      );

  // Pointer to interface object, used as callback in Undo/Redo framework
  PaintbrushToolEventInterface::Pointer m_Interface;

  int GetDataIndex(bool isLeftMouseButton);

  // Cursor size for editing, and cursor type is currently always a cross.
  int m_CursorSize;

  // This is the 3D geometry associated with the m_WorkingImage, where we assume both working images have same size and geometry.
  mitk::BaseGeometry* m_WorkingImageGeometry;

  // This points to the current working image, assuming that we are only ever processing, left, middle or right mouse button at any one time.
  mitk::Image* m_WorkingImage;

  // Used between MouseDown and MouseMoved events to track movement.
  mitk::Point3D m_MostRecentPointInMillimetres;

  // If m_ErosionMode is true, we update WorkingData 0 and 1, if m_ErosionMode is false, we update WorkingData 2 and 3.
  bool m_ErosionMode;

  // Stores the current display interactor configurations when this tool is activated.
  // The configurations are restored when the tool is deactivated.
  std::map<us::ServiceReferenceU, mitk::EventConfig> m_DisplayInteractorConfigs;

};

}

#endif