Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit

Paintbrush tool for InteractiveSegmentation. More...

#include <mitkPaintbrushTool.h>

Inheritance diagram for mitk::PaintbrushTool:
Collaboration diagram for mitk::PaintbrushTool:

Public Member Functions

 mitkClassMacro (PaintbrushTool, FeedbackContourTool)
 
void SetSize (int value)
 
- Public Member Functions inherited from mitk::FeedbackContourTool
 mitkClassMacro (FeedbackContourTool, SegTool2D)
 
- Public Member Functions inherited from mitk::SegTool2D
 mitkClassMacro (SegTool2D, Tool)
 
void SetShowMarkerNodes (bool)
 
void SetEnable3DInterpolation (bool)
 Enables or disables the 3D interpolation after writing back the 2D segmentation result, and defaults to true. More...
 
- Public Member Functions inherited from mitk::Tool
 mitkClassMacro (Tool, EventStateMachine)
 
virtual const char ** GetXPM () const =0
 Returns an icon in the XPM format. More...
 
virtual std::string GetIconPath () const
 Returns the path of an icon. More...
 
virtual us::ModuleResource GetCursorIconResource () const
 Returns the path of a cursor icon. More...
 
virtual us::ModuleResource GetIconResource () const
 Returns the tool button icon of the tool wrapped by a usModuleResource. More...
 
virtual const char * GetName () const =0
 Returns the name of this tool. Make it short! More...
 
virtual const char * GetGroup () const
 Name of a group. More...
 
virtual void InitializeStateMachine ()
 
virtual itk::Object::Pointer GetGUI (const std::string &toolkitPrefix, const std::string &toolkitPostfix)
 Interface for GUI creation. More...
 
virtual NodePredicateBase::ConstPointer GetReferenceDataPreference () const
 
virtual NodePredicateBase::ConstPointer GetWorkingDataPreference () const
 
DataNode::Pointer CreateEmptySegmentationNode (Image *original, const std::string &organName, const mitk::Color &color)
 
DataNode::Pointer CreateSegmentationNode (Image *image, const std::string &organName, const mitk::Color &color)
 
virtual bool CanHandle (BaseData *referenceData) const
 
- Public Member Functions inherited from mitk::EventStateMachine
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
bool LoadStateMachine (const std::string &filename, const us::Module *module=nullptr)
 Loads XML resource. More...
 
bool HandleEvent (InteractionEvent *event, DataNode *dataNode)
 
void EnableUndo (bool enable)
 Enables or disabled Undo. More...
 
void EnableInteraction (bool enable)
 Enables/disables the state machine. In un-enabled state it won't react to any events. More...
 
- Public Member Functions inherited from mitk::InteractionEventHandler
bool SetEventConfig (const std::string &filename, const us::Module *module=nullptr)
 Loads a configuration from an XML resource. More...
 
bool SetEventConfig (const EventConfig &config)
 Loads a configuration from an EventConfig object. More...
 
EventConfig GetEventConfig () const
 Returns the current configuration. More...
 
bool AddEventConfig (const std::string &filename, const us::Module *module=nullptr)
 This method extends the configuration. More...
 
bool AddEventConfig (const EventConfig &config)
 This method extends the configuration. The configuration from the EventConfig object is loaded and only the ones conflicting are replaced by the new one. This way several configurations can be combined. More...
 
- Public Member Functions inherited from mitk::InteractionEventObserver
 InteractionEventObserver ()
 
virtual ~InteractionEventObserver ()
 
void Disable ()
 
void Enable ()
 
bool IsEnabled () const
 

Public Attributes

Message1< int > SizeChanged
 
- Public Attributes inherited from mitk::Tool
Message GUIProcessEventsMessage
 To let GUI process new events (e.g. qApp->processEvents() ) More...
 
Message1< std::string > ErrorMessage
 To send error messages (to be shown by some GUI) More...
 
Message1< bool > CurrentlyBusy
 To send whether the tool is busy (to be shown by some GUI) More...
 
Message1< std::string > GeneralMessage
 To send general messages (to be shown by some GUI) More...
 

Protected Member Functions

 PaintbrushTool (int paintingPixelValue=1)
 
virtual ~PaintbrushTool ()
 
void ConnectActionsAndFunctions () override
 
virtual void Activated () override
 Called when the tool gets activated. More...
 
virtual void Deactivated () override
 Called when the tool gets deactivated. More...
 
virtual void OnMousePressed (StateMachineAction *, InteractionEvent *)
 
virtual void OnMouseMoved (StateMachineAction *, InteractionEvent *)
 
virtual void OnPrimaryButtonPressedMoved (StateMachineAction *, InteractionEvent *)
 
virtual void MouseMoved (mitk::InteractionEvent *interactionEvent, bool leftMouseButtonPressed)
 
virtual void OnMouseReleased (StateMachineAction *, InteractionEvent *)
 
virtual void OnInvertLogic (StateMachineAction *, InteractionEvent *)
 
void UpdateContour (const InteractionPositionEvent *)
 
mitk::Point2D upperLeft (mitk::Point2D p)
 
void CheckIfCurrentSliceHasChanged (const InteractionPositionEvent *event)
 
void OnToolManagerWorkingDataModified ()
 
- Protected Member Functions inherited from mitk::FeedbackContourTool
 FeedbackContourTool ()
 
 FeedbackContourTool (const char *)
 
virtual ~FeedbackContourTool ()
 
ContourModelGetFeedbackContour ()
 
void SetFeedbackContour (ContourModel::Pointer)
 
void SetFeedbackContourVisible (bool)
 
void SetFeedbackContourColor (float r, float g, float b)
 Provide values from 0.0 (black) to 1.0 (full color) More...
 
void SetFeedbackContourColorDefault ()
 
ContourModel::Pointer ProjectContourTo2DSlice (Image *slice, ContourModel *contourIn3D, bool correctionForIpSegmentation=false, bool constrainToInside=true)
 Projects a contour onto an image point by point. Converts from world to index coordinates. More...
 
ContourModel::Pointer BackProjectContourFrom2DSlice (const BaseGeometry *sliceGeometry, ContourModel *contourIn2D, bool correctionForIpSegmentation=false)
 Projects a slice index coordinates of a contour back into world coordinates. More...
 
void FillContourInSlice (ContourModel *projectedContour, Image *sliceImage, int paintingPixelValue=1)
 Fill a contour in a 2D slice with a specified pixel value. More...
 
void FillContourInSlice (ContourModel *projectedContour, unsigned int timeStep, Image *sliceImage, int paintingPixelValue=1)
 Fill a contour in a 2D slice with a specified pixel value at a given time step. More...
 
- Protected Member Functions inherited from mitk::SegTool2D
 SegTool2D ()
 
 SegTool2D (const char *)
 
virtual ~SegTool2D ()
 
virtual bool FilterEvents (InteractionEvent *interactionEvent, DataNode *dataNode) override
 Filters events that cannot be handle by 2D segmentation tools. More...
 
Image::Pointer GetAffectedImageSliceAs2DImage (const InteractionPositionEvent *positionEvent, const Image *image, unsigned int component=0)
 Extract the slice of an image that the user just scribbles on. The given component denotes the vector component of a dwi-image. More...
 
Image::Pointer GetAffectedImageSliceAs2DImage (const PlaneGeometry *planeGeometry, const Image *image, unsigned int timeStep, unsigned int component=0)
 Extract the slice of an image cut by given plane. The given component denotes the vector component of a dwi-image. More...
 
Image::Pointer GetAffectedWorkingSlice (const InteractionPositionEvent *)
 Extract the slice of the currently selected working image that the user just scribbles on. More...
 
Image::Pointer GetAffectedReferenceSlice (const InteractionPositionEvent *)
 Extract the slice of the currently selected reference image that the user just scribbles on. More...
 
void WriteBackSegmentationResult (const InteractionPositionEvent *, Image *)
 
void WriteBackSegmentationResult (const PlaneGeometry *planeGeometry, Image *, unsigned int timeStep)
 
void WriteBackSegmentationResult (std::vector< SliceInformation > sliceList, bool writeSliceToVolume=true)
 
void WritePreviewOnWorkingImage (Image *targetSlice, Image *sourceSlice, Image *workingImage, int paintingPixelValue, int timestep)
 
void WriteSliceToVolume (SliceInformation sliceInfo)
 
int AddContourmarker ()
 Adds a new node called Contourmarker to the datastorage which holds a mitk::PlanarFigure. By selecting this node the slicestack will be reoriented according to the PlanarFigure's Geometry. More...
 
void InteractiveSegmentationBugMessage (const std::string &message)
 
- Protected Member Functions inherited from mitk::Tool
virtual void SetToolManager (ToolManager *)
 
void ConnectActionsAndFunctions () override
 
 Tool ()
 
 Tool (const char *)
 
virtual ~Tool ()
 
virtual void Notify (InteractionEvent *interactionEvent, bool isHandled) override
 
bool FilterEvents (InteractionEvent *, DataNode *) override
 
- Protected Member Functions inherited from mitk::EventStateMachine
 EventStateMachine ()
 
virtual ~EventStateMachine ()
 
void AddActionFunction (const std::string &action, TActionFunctor *functor)
 
void AddActionFunction (const std::string &action, const ActionFunctionDelegate &delegate)
 
void AddConditionFunction (const std::string &condition, const ConditionFunctionDelegate &delegate)
 
StateMachineStateGetCurrentState () const
 
void ResetToStartState ()
 ResetToStartState Reset state machine to it initial starting state. More...
 
virtual bool CheckCondition (const StateMachineCondition &condition, const InteractionEvent *interactionEvent)
 
virtual void ExecuteAction (StateMachineAction *action, InteractionEvent *interactionEvent)
 
void SetMouseCursor (const char *xpm[], int hotspotX, int hotspotY)
 Sets the specified mouse cursor. More...
 
void ResetMouseCursor ()
 Resets the mouse cursor (if modified by the SlicesCoordinator) to its original state. More...
 
StateMachineTransitionGetExecutableTransition (InteractionEvent *event)
 Returns the executable transition for the given event. More...
 
- Protected Member Functions inherited from mitk::InteractionEventHandler
 InteractionEventHandler ()
 
virtual ~InteractionEventHandler ()
 
PropertyList::Pointer GetAttributes () const
 
std::string MapToEventVariant (InteractionEvent *interactionEvent)
 
virtual void ConfigurationChanged ()
 

Protected Attributes

int m_PaintingPixelValue
 
ContourModel::Pointer m_MasterContour
 
int m_LastContourSize
 
Image::Pointer m_WorkingSlice
 
PlaneGeometry::Pointer m_CurrentPlane
 
DataNode::Pointer m_WorkingNode
 
mitk::Point3D m_LastPosition
 
- Protected Attributes inherited from mitk::FeedbackContourTool
ContourModel::Pointer m_FeedbackContour
 
DataNode::Pointer m_FeedbackContourNode
 
bool m_FeedbackContourVisible
 
- Protected Attributes inherited from mitk::SegTool2D
BaseRendererm_LastEventSender
 
unsigned int m_LastEventSlice
 
- Protected Attributes inherited from mitk::Tool
std::string m_EventConfig
 Let subclasses change their event configuration. More...
 
ToolManagerm_ToolManager
 
- Protected Attributes inherited from mitk::EventStateMachine
bool m_IsActive
 
UndoControllerm_UndoController
 
bool m_UndoEnabled
 

Static Protected Attributes

static int m_Size
 

Additional Inherited Members

- Public Types inherited from mitk::Tool
typedef mitk::Label::PixelType DefaultSegmentationDataType
 
- Public Types inherited from mitk::EventStateMachine
typedef EventStateMachine Self
 
typedef InteractionEventHandler Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef std::map< std::string, TActionFunctor * > ActionFunctionsMapType
 
typedef itk::SmartPointer< StateMachineStateStateMachineStateType
 
- Public Types inherited from mitk::InteractionEventHandler
typedef InteractionEventHandler Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Static Public Member Functions inherited from mitk::SegTool2D
static bool DetermineAffectedImageSlice (const Image *image, const PlaneGeometry *plane, int &affectedDimension, int &affectedSlice)
 Calculates for a given Image and PlaneGeometry, which slice of the image (in index corrdinates) is meant by the plane. More...
 
static void UpdateSurfaceInterpolation (const Image *slice, const Image *workingImage, const PlaneGeometry *plane, bool detectIntersection)
 Updates the surface interpolation by extracting the contour form the given slice. More...
 
- Static Public Member Functions inherited from mitk::EventStateMachine
static const char * GetStaticNameOfClass ()
 
- Static Public Member Functions inherited from mitk::InteractionEventHandler
static const char * GetStaticNameOfClass ()
 
- Protected Types inherited from mitk::EventStateMachine
typedef MessageAbstractDelegate2< StateMachineAction *, InteractionEvent *, void > ActionFunctionDelegate
 
typedef MessageAbstractDelegate1< const InteractionEvent *, bool > ConditionFunctionDelegate
 

Detailed Description

Paintbrush tool for InteractiveSegmentation.

See also
FeedbackContourTool
ExtractImageFilter
OverwriteSliceImageFilter

Simple paintbrush drawing tool. Right now there are only circular pens of varying size.

Warning
Only to be instantiated by mitk::ToolManager.
Author
maleike

Definition at line 49 of file mitkPaintbrushTool.h.

Constructor & Destructor Documentation

mitk::PaintbrushTool::PaintbrushTool ( int  paintingPixelValue = 1)
protected
mitk::PaintbrushTool::~PaintbrushTool ( )
protectedvirtual

Definition at line 48 of file mitkPaintbrushTool.cpp.

Member Function Documentation

void mitk::PaintbrushTool::Activated ( )
overrideprotectedvirtual

Called when the tool gets activated.

Derived tools should call their parents implementation at the beginning of the overriding function.

Reimplemented from mitk::FeedbackContourTool.

Definition at line 61 of file mitkPaintbrushTool.cpp.

References OnToolManagerWorkingDataModified(), and mitk::FeedbackContourTool::SetFeedbackContourVisible().

void mitk::PaintbrushTool::ConnectActionsAndFunctions ( )
overrideprotectedvirtual

Is called after loading a statemachine. Overwrite this function in specific interactor implementations. Connect actions and functions using the CONNECT_FUNCTION macro within this function.

Reimplemented from mitk::EventStateMachine.

Definition at line 52 of file mitkPaintbrushTool.cpp.

References CONNECT_FUNCTION.

void mitk::PaintbrushTool::Deactivated ( )
overrideprotectedvirtual

Called when the tool gets deactivated.

Derived tools should call their parents implementation at the end of the overriding function.

Reimplemented from mitk::FeedbackContourTool.

Definition at line 71 of file mitkPaintbrushTool.cpp.

References OnToolManagerWorkingDataModified(), and mitk::FeedbackContourTool::SetFeedbackContourVisible().

mitk::PaintbrushTool::mitkClassMacro ( PaintbrushTool  ,
FeedbackContourTool   
)
void mitk::PaintbrushTool::OnInvertLogic ( StateMachineAction ,
InteractionEvent interactionEvent 
)
protectedvirtual

Called when the CTRL key is pressed. Will change the painting pixel value from 0 to 1 or from 1 to 0.

Definition at line 522 of file mitkPaintbrushTool.cpp.

References mitk::RenderingManager::GetInstance(), mitk::RenderingManager::RequestUpdateAll(), mitk::FeedbackContourTool::SetFeedbackContourColor(), and mitk::FeedbackContourTool::SetFeedbackContourColorDefault().

void mitk::PaintbrushTool::OnMouseMoved ( StateMachineAction ,
InteractionEvent interactionEvent 
)
protectedvirtual

Definition at line 317 of file mitkPaintbrushTool.cpp.

void mitk::PaintbrushTool::OnMousePressed ( StateMachineAction ,
InteractionEvent interactionEvent 
)
protectedvirtual

Just show the contour, get one point as the central point and add surrounding points to the contour.

Definition at line 285 of file mitkPaintbrushTool.cpp.

References mitk::InteractionPositionEvent::GetPositionInWorld(), mitk::InteractionEvent::GetSender(), mitk::BaseRenderer::GetSlice(), mitk::BoolProperty::New(), mitk::LevelWindowProperty::New(), and mitk::DataNode::New().

void mitk::PaintbrushTool::OnMouseReleased ( StateMachineAction ,
InteractionEvent interactionEvent 
)
protectedvirtual
void mitk::PaintbrushTool::OnPrimaryButtonPressedMoved ( StateMachineAction ,
InteractionEvent interactionEvent 
)
protectedvirtual

Definition at line 322 of file mitkPaintbrushTool.cpp.

void mitk::PaintbrushTool::OnToolManagerWorkingDataModified ( )
protected

Definition at line 602 of file mitkPaintbrushTool.cpp.

Referenced by Activated(), and Deactivated().

void mitk::PaintbrushTool::SetSize ( int  value)

Definition at line 84 of file mitkPaintbrushTool.cpp.

void mitk::PaintbrushTool::UpdateContour ( const InteractionPositionEvent positionEvent)
protected

Definition at line 96 of file mitkPaintbrushTool.cpp.

References mitk::ContourModel::New().

mitk::Point2D mitk::PaintbrushTool::upperLeft ( mitk::Point2D  p)
protected

Little helper function. Returns the upper left corner of the given pixel.

Definition at line 89 of file mitkPaintbrushTool.cpp.

Member Data Documentation

PlaneGeometry::Pointer mitk::PaintbrushTool::m_CurrentPlane
protected

Definition at line 101 of file mitkPaintbrushTool.h.

Referenced by PaintbrushTool().

int mitk::PaintbrushTool::m_LastContourSize
protected

Definition at line 98 of file mitkPaintbrushTool.h.

mitk::Point3D mitk::PaintbrushTool::m_LastPosition
protected

Definition at line 103 of file mitkPaintbrushTool.h.

ContourModel::Pointer mitk::PaintbrushTool::m_MasterContour
protected

Definition at line 96 of file mitkPaintbrushTool.h.

Referenced by PaintbrushTool().

int mitk::PaintbrushTool::m_PaintingPixelValue
protected

Definition at line 93 of file mitkPaintbrushTool.h.

int mitk::PaintbrushTool::m_Size
staticprotected

Definition at line 94 of file mitkPaintbrushTool.h.

DataNode::Pointer mitk::PaintbrushTool::m_WorkingNode
protected

Definition at line 102 of file mitkPaintbrushTool.h.

Referenced by PaintbrushTool().

Image::Pointer mitk::PaintbrushTool::m_WorkingSlice
protected

Definition at line 100 of file mitkPaintbrushTool.h.

Message1<int> mitk::PaintbrushTool::SizeChanged

Definition at line 53 of file mitkPaintbrushTool.h.


The documentation for this class was generated from the following files: