Medical Imaging Interaction Toolkit  2021.02.99-19049835
Medical Imaging Interaction Toolkit

Base class for tools that use a contour for feedback. More...

#include <mitkFeedbackContourTool.h>

Inheritance diagram for mitk::FeedbackContourTool:
Collaboration diagram for mitk::FeedbackContourTool:

Public Member Functions

 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...
 
void Activated () override
 Called when the tool gets activated. More...
 
void Deactivated () override
 Called when the tool gets deactivated. More...
 
virtual void SetIsTimePointChangeAware (bool _arg)
 
virtual bool GetIsTimePointChangeAware ()
 
virtual void IsTimePointChangeAwareOn ()
 
virtual void IsTimePointChangeAwareOff ()
 
- 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 (const Image *original, const std::string &organName, const mitk::Color &color) const
 
DataNode::Pointer CreateSegmentationNode (Image *image, const std::string &organName, const mitk::Color &color) const
 
virtual bool CanHandle (const BaseData *referenceData, const BaseData *workingData) 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
 

Protected Member Functions

 FeedbackContourTool ()
 
 FeedbackContourTool (const char *)
 
 ~FeedbackContourTool () override
 
const ContourModelGetFeedbackContour () const
 
void InitializeFeedbackContour (bool isClosed)
 
void ClearsCurrentFeedbackContour (bool isClosed)
 
void UpdateCurrentFeedbackContour (const ContourModel *sourceModel, TimeStepType sourceTimeStep=0)
 
void UpdateFeedbackContour (const ContourModel *sourceModel, TimeStepType feedbackTimeStep, TimeStepType sourceTimeStep=0)
 
void AddVertexToCurrentFeedbackContour (const Point3D &point)
 
void AddVertexToFeedbackContour (const Point3D &point, TimeStepType feedbackTimeStep)
 
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 ()
 
void Deactivated () override
 Called when the tool gets deactivated. More...
 
void Activated () override
 Called when the tool gets activated. More...
 
ContourModel::Pointer ProjectContourTo2DSlice (const Image *slice, const ContourModel *contourIn3D)
 Projects a contour onto an image point by point. Converts from world to index coordinates. More...
 
ContourModel::Pointer BackProjectContourFrom2DSlice (const BaseGeometry *sliceGeometry, const ContourModel *contourIn2D)
 Projects a slice index coordinates of a contour back into world coordinates. More...
 
void WriteBackFeedbackContourAsSegmentationResult (const InteractionPositionEvent *positionEvent, int paintingPixelValue, bool setInvisibleAfterSuccess=true)
 
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 *, const us::Module *interactorModule=nullptr)
 
 ~SegTool2D () override
 
DataNodeGetWorkingDataNode () const
 returns the segmentation node that should be modified by the tool. More...
 
ImageGetWorkingData () const
 
DataNodeGetReferenceDataNode () const
 
ImageGetReferenceData () const
 
virtual void OnTimePointChanged ()
 
bool FilterEvents (InteractionEvent *interactionEvent, DataNode *dataNode) override
 Filters events that cannot be handled by 2D segmentation tools. More...
 
Image::Pointer GetAffectedWorkingSlice (const InteractionPositionEvent *) const
 Extract the slice of the currently selected working image that the user just scribbles on. More...
 
Image::Pointer GetAffectedReferenceSlice (const InteractionPositionEvent *) const
 Extract the slice of the currently selected reference image that the user just scribbles on. More...
 
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)
 
int AddContourmarker (const PlaneGeometry *planeGeometry, unsigned int sliceIndex)
 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 passed PlanarFigure's Geometry. More...
 
void InteractiveSegmentationBugMessage (const std::string &message) const
 
virtual TimePointType GetLastTimePointTriggered ()
 
- Protected Member Functions inherited from mitk::Tool
virtual void SetToolManager (ToolManager *)
 
ToolManagerGetToolManager () const
 
mitk::DataStorageGetDataStorage () const
 
void ConnectActionsAndFunctions () override
 
 Tool (const char *, const us::Module *interactorModule=nullptr)
 
 ~Tool () override
 
void Notify (InteractionEvent *interactionEvent, bool isHandled) override
 
bool FilterEvents (InteractionEvent *, DataNode *) override
 
- Protected Member Functions inherited from mitk::EventStateMachine
 EventStateMachine ()
 
 ~EventStateMachine () override
 
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 ()
 
 ~InteractionEventHandler () override
 
PropertyList::Pointer GetAttributes () const
 
std::string MapToEventVariant (InteractionEvent *interactionEvent)
 
virtual void ConfigurationChanged ()
 

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 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 an vector image. More...
 
static Image::Pointer GetAffectedImageSliceAs2DImage (const PlaneGeometry *planeGeometry, const Image *image, TimeStepType timeStep, unsigned int component=0)
 Extract the slice of an image cut by given plane. The given component denotes the vector component of a vector image. More...
 
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)
 
static void WriteSliceToVolume (Image *workingImage, const PlaneGeometry *planeGeometry, const Image *slice, TimeStepType timeStep, bool allowUndo)
 
- Static Public Member Functions inherited from mitk::EventStateMachine
static const char * GetStaticNameOfClass ()
 
- Static Public Member Functions inherited from mitk::InteractionEventHandler
static const char * GetStaticNameOfClass ()
 
- 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 Types inherited from mitk::EventStateMachine
typedef MessageAbstractDelegate2< StateMachineAction *, InteractionEvent *, void > ActionFunctionDelegate
 
typedef MessageAbstractDelegate1< const InteractionEvent *, bool > ConditionFunctionDelegate
 
- Static Protected Member Functions inherited from mitk::SegTool2D
static void UpdateSurfaceInterpolation (const std::vector< SliceInformation > &sliceInfos, const Image *workingImage, bool detectIntersection)
 Updates the surface interpolation by extracting the contour form the given slice. More...
 
static void WriteBackSegmentationResults (const DataNode *workingNode, const std::vector< SliceInformation > &sliceList, bool writeSliceToVolume=true)
 Writes all provided source slices into the data of the passed workingNode. The function does the following: 1) for every passed slice write it to workingNode (and generate and undo/redo step); 2) update the surface interpolation and 3) marke the node as modified. More...
 
static void WritePreviewOnWorkingImage (Image *targetSlice, const Image *sourceSlice, const Image *workingImage, int paintingPixelValue)
 
static void WriteSliceToVolume (Image *workingImage, const SliceInformation &sliceInfo, bool allowUndo)
 
- 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...
 
- Protected Attributes inherited from mitk::EventStateMachine
bool m_IsActive
 
UndoControllerm_UndoController
 
bool m_UndoEnabled
 

Detailed Description

Base class for tools that use a contour for feedback.

See also
Tool
ContourModel

Implements helper methods, that might be of use to all kind of 2D segmentation tools that use a contour for user feedback.

  • Providing a feedback contour that might be added or removed from the visible scene (SetFeedbackContourVisible).
  • Filling of a contour into a 2D slice

These helper methods are actually implemented in ContourUtils now. FeedbackContourTool only forwards such requests.

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

Definition at line 49 of file mitkFeedbackContourTool.h.

Constructor & Destructor Documentation

◆ FeedbackContourTool() [1/2]

mitk::FeedbackContourTool::FeedbackContourTool ( )
protected

◆ FeedbackContourTool() [2/2]

mitk::FeedbackContourTool::FeedbackContourTool ( const char *  )
protected

◆ ~FeedbackContourTool()

mitk::FeedbackContourTool::~FeedbackContourTool ( )
overrideprotected

Member Function Documentation

◆ Activated()

void mitk::FeedbackContourTool::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::Tool.

Reimplemented in mitk::RegionGrowingTool, mitk::PaintbrushTool, and mitk::SetRegionTool.

◆ AddVertexToCurrentFeedbackContour()

void mitk::FeedbackContourTool::AddVertexToCurrentFeedbackContour ( const Point3D point)
protected

Adds a vertex to the feedback contour for the current time point.

◆ AddVertexToFeedbackContour()

void mitk::FeedbackContourTool::AddVertexToFeedbackContour ( const Point3D point,
TimeStepType  feedbackTimeStep 
)
protected

Adds a vertex to the feedback contour for the passed time step. If time step is invalid, nothing will be added.

◆ BackProjectContourFrom2DSlice()

ContourModel::Pointer mitk::FeedbackContourTool::BackProjectContourFrom2DSlice ( const BaseGeometry sliceGeometry,
const ContourModel contourIn2D 
)
protected

Projects a slice index coordinates of a contour back into world coordinates.

Parameters
sliceGeometry
contourIn2D

◆ ClearsCurrentFeedbackContour()

void mitk::FeedbackContourTool::ClearsCurrentFeedbackContour ( bool  isClosed)
protected

Clears the current time step of the feedback contour and resets its closed state.

◆ Deactivated()

void mitk::FeedbackContourTool::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::Tool.

Reimplemented in mitk::RegionGrowingTool, mitk::PaintbrushTool, and mitk::SetRegionTool.

◆ FillContourInSlice() [1/2]

void mitk::FeedbackContourTool::FillContourInSlice ( ContourModel projectedContour,
Image sliceImage,
int  paintingPixelValue = 1 
)
protected

Fill a contour in a 2D slice with a specified pixel value.

◆ FillContourInSlice() [2/2]

void mitk::FeedbackContourTool::FillContourInSlice ( ContourModel projectedContour,
unsigned int  timeStep,
Image sliceImage,
int  paintingPixelValue = 1 
)
protected

Fill a contour in a 2D slice with a specified pixel value at a given time step.

◆ GetFeedbackContour()

const ContourModel* mitk::FeedbackContourTool::GetFeedbackContour ( ) const
protected

◆ InitializeFeedbackContour()

void mitk::FeedbackContourTool::InitializeFeedbackContour ( bool  isClosed)
protected

(Re)initialize the feesback contour by creating a new instance. It is assured that the new instance as the same time geometry than the working image.

◆ mitkClassMacro()

mitk::FeedbackContourTool::mitkClassMacro ( FeedbackContourTool  ,
SegTool2D   
)

◆ ProjectContourTo2DSlice()

ContourModel::Pointer mitk::FeedbackContourTool::ProjectContourTo2DSlice ( const Image slice,
const ContourModel contourIn3D 
)
protected

Projects a contour onto an image point by point. Converts from world to index coordinates.

Parameters
slice
contourIn3D

◆ SetFeedbackContourColor()

void mitk::FeedbackContourTool::SetFeedbackContourColor ( float  r,
float  g,
float  b 
)
protected

Provide values from 0.0 (black) to 1.0 (full color)

◆ SetFeedbackContourColorDefault()

void mitk::FeedbackContourTool::SetFeedbackContourColorDefault ( )
protected

◆ SetFeedbackContourVisible()

void mitk::FeedbackContourTool::SetFeedbackContourVisible ( bool  )
protected

◆ UpdateCurrentFeedbackContour()

void mitk::FeedbackContourTool::UpdateCurrentFeedbackContour ( const ContourModel sourceModel,
TimeStepType  sourceTimeStep = 0 
)
protected

Updates the feedback contour of the currently selected time point. The update will be done by clearing all existings vertices at the current time point and copying the vertics of the source model at the specified source time step.

◆ UpdateFeedbackContour()

void mitk::FeedbackContourTool::UpdateFeedbackContour ( const ContourModel sourceModel,
TimeStepType  feedbackTimeStep,
TimeStepType  sourceTimeStep = 0 
)
protected

Updates the feedback contour at the time step specified by feedbackTimeStep. The update will be done by clearing all existings vertices at feedbackTimeStep and copying the vertics of the source model at the specified source time step.

◆ WriteBackFeedbackContourAsSegmentationResult()

void mitk::FeedbackContourTool::WriteBackFeedbackContourAsSegmentationResult ( const InteractionPositionEvent positionEvent,
int  paintingPixelValue,
bool  setInvisibleAfterSuccess = true 
)
protected

Helper methods that checks all precondition and if they are fullfilled does the following:

  1. Gets the contour of the time point specified by positionEvent.
  2. Gets the affacted working slice of the time point specified by positionEvent.
  3. projects the contour onto the working slice and then fills it with the passed paintingPixelValue (adjusted by the current active lable value) to the slice.
  4. writes the slice back into the working image using SegTool2D::WriteBackSegmentationResult().

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