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

#include <mitkFeedbackContourTool.h>

Inheritance diagram for mitk::FeedbackContourTool:

[legend]

Collaboration diagram for mitk::FeedbackContourTool:

[legend]

Public Member Functions
	mitkClassMacro (FeedbackContourTool, SegTool2D)

Public Member Functions inherited from mitk::SegTool2D
	mitkClassMacro (SegTool2D, Tool)

void	SetShowMarkerNodes (bool show)
	Sets whether contour marker nodes should be visible in the DataStorage. More...

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 ()

DataNode *	GetWorkingDataNode () const
	Returns the segmentation node that should be modified by the tool. More...

MultiLabelSegmentation *	GetWorkingData () const
	Returns the working data (multi-label segmentation image). More...

DataNode *	GetReferenceDataNode () const
	Returns the reference data node. More...

Image *	GetReferenceData () const
	Returns the reference image data. More...

Public Member Functions inherited from mitk::Tool
	mitkClassMacro (Tool, EventStateMachine)

virtual us::ModuleResource	GetCursorIconResource () const
	Returns the cursor icon of the tool wrapped by a usModuleResource. 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 mitk::Label::AlgorithmType	GetAlgorithmType () const
	Returns the intrinsic algorithm type of this tool, used to stamp label provenance. More...

virtual const char *	GetGroup () const
	Name of a group. More...

virtual bool	IsEligibleForAutoInit () const
	Returns whether this tool is eligible for auto-initialization by ToolManager. More...

virtual void	InitializeStateMachine ()
	Initializes the state machine for this tool based on the interaction type. More...

virtual itk::Object::Pointer	GetGUI (const std::string &toolkitPrefix, const std::string &toolkitPostfix)
	Interface for GUI creation. More...

virtual NodePredicateBase::ConstPointer	GetReferenceDataPreference () const
	Returns a predicate describing valid reference data for this tool. More...

virtual NodePredicateBase::ConstPointer	GetWorkingDataPreference () const
	Returns a predicate describing valid working data for this tool. More...

virtual bool	CanHandle (const BaseData referenceData, const BaseData workingData) const
	Checks if a tool can handle the given reference data and optional working data. More...

virtual bool	ConfirmBeforeDeactivation ()
	Method call to invoke a dialog box just before exiting. More...

Public Member Functions inherited from mitk::EventStateMachine
	mitkClassMacro (EventStateMachine, InteractionEventHandler)

bool	LoadStateMachine (const std::string &filename, const us::Module *module=nullptr)
	Load a state machine pattern from an XML resource file. More...

bool	HandleEvent (InteractionEvent event, DataNode dataNode)
	Process an incoming interaction event. More...

void	EnableUndo (bool enable)
	Enable or disable the undo mechanism for this state machine. More...

void	EnableInteraction (bool enable)
	Enable or disable the state machine. More...

Public Member Functions inherited from mitk::InteractionEventHandler
	mitkClassMacroItkParent (InteractionEventHandler, itk::Object)

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 ()
	Disable this observer so it no longer receives notifications. More...

void	Enable ()
	Enable this observer so it receives notifications. More...

bool	IsEnabled () const
	Check whether this observer is currently enabled. More...

Protected Member Functions
	FeedbackContourTool (const char *)

	~FeedbackContourTool () override

const ContourModel *	GetFeedbackContour () 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	SetFeedbackContourColor (const Color &color)

void	SetFeedbackContourColorDefault ()

void	SetFeedbackContourWidth (float width)

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, MultiLabelSegmentation::LabelValueType labelValue, bool addMode, bool setInvisibleAfterSuccess=true)
	Checks preconditions and writes the feedback contour as a segmentation result. More...

mitk::Image::Pointer	GenerateSliceWithContourUpdate (const MultiLabelSegmentation seg, const PlaneGeometry sliceGeometry, const ContourModel *contour, MultiLabelSegmentation::LabelValueType labelValue, TimePointType timePoint, bool addMode)
	Generates an updated slice image with the contour applied. More...

Protected Member Functions inherited from mitk::SegTool2D
	SegTool2D ()

	SegTool2D (const char , const us::Module interactorModule=nullptr)

	~SegTool2D () override

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)

virtual MultiLabelSegmentation::LabelValueVectorType	GetAffectedLabelValues () const
	Returns the label value(s) whose pixels this tool's writeback actually modifies, so the provenance stamp at the writeback choke point lands on the right label. The default is the active label; tools that write a label other than the active one (e.g. erase/close operate on the clicked label) override this. An empty result records no tool use. More...

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	DisableContourMarkers ()

void	InteractiveSegmentationBugMessage (const std::string &message) const

virtual TimePointType	GetLastTimePointTriggered ()

void	PushCursor ()
	Pushes the current tool cursor onto the cursor stack. More...

void	PushCursor (us::ModuleResource cursorResource)
	Pushes a custom cursor onto the cursor stack. More...

void	PopCursor (bool popFirstCursor=false)
	Pops the most recently pushed cursor from the stack. More...

void	PopAllCursors ()
	Pops all cursors from the stack, restoring the default cursor. More...

Protected Member Functions inherited from mitk::Tool
virtual void	SetToolManager (ToolManager *)

ToolManager *	GetToolManager () const

mitk::DataStorage *	GetDataStorage () const

void	ConnectActionsAndFunctions () override

	Tool (const char , const us::Module interactorModule=nullptr)

	~Tool () override

void	Notify (InteractionEvent *interactionEvent, bool isHandled) override
	Called by the Dispatcher to notify this observer about an InteractionEvent. More...

bool	FilterEvents (InteractionEvent , DataNode ) override

Protected Member Functions inherited from mitk::EventStateMachine
	EventStateMachine ()

	~EventStateMachine () override

void	AddActionFunction (const std::string &action, const ActionFunctionDelegate &delegate)

void	AddConditionFunction (const std::string &condition, const ConditionFunctionDelegate &delegate)

StateMachineState *	GetCurrentState () 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 to its original state. More...

StateMachineTransition *	GetExecutableTransition (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 itk::SmartPointer< StateMachineState >	StateMachineStateType

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 coordinates) is meant by the plane. More...

static void	UpdateAllSurfaceInterpolations (const MultiLabelSegmentation workingImage, TimeStepType timeStep, const PlaneGeometry plane, bool detectIntersection)
	Updates the surface interpolations by extracting contours from 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)
	Extract the slice of an image cut by the given plane at a specified time point. More...

static void	WriteBackSegmentationResult (const DataNode workingNode, const PlaneGeometry planeGeometry, const Image *segmentationResult, TimeStepType timeStep, const std::string &toolName)
	Writes the provided segmentation result slice into the data of the passed workingNode. More...

static void	WriteSliceToVolume (Image workingImage, const PlaneGeometry planeGeometry, const Image *slice, TimeStepType timeStep)
	Writes a provided slice into the passed working image. More...

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, mitk::Label::PixelType activeLabelValue, bool silent=false)
	Updates the surface interpolation by extracting contours from given slices. More...

static void	WriteBackSegmentationResults (const DataNode *workingNode, const std::vector< SliceInformation > &sliceList, bool writeSliceToVolume=true, bool allowUndo=true, const std::string &toolName="")
	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) mark the node as modified. More...

static void	WriteSliceToVolume (Image *workingImage, const SliceInformation &sliceInfo)

static bool	IsPositionEventInsideImageRegion (InteractionPositionEvent positionEvent, const BaseData data)

Protected Attributes inherited from mitk::SegTool2D
BaseRenderer *	m_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

UndoController *	m_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 ContourModelUtils now. FeedbackContourTool only forwards such requests.

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

Author: nolden

Definition at line 48 of file mitkFeedbackContourTool.h.

Constructor & Destructor Documentation

◆ FeedbackContourTool()

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, and mitk::PaintbrushTool.

◆ 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, and mitk::PaintbrushTool.

◆ GenerateSliceWithContourUpdate()

mitk::Image::Pointer mitk::FeedbackContourTool::GenerateSliceWithContourUpdate	(	const MultiLabelSegmentation *	seg,
		const PlaneGeometry *	sliceGeometry,
		const ContourModel *	contour,
		MultiLabelSegmentation::LabelValueType	labelValue,
		TimePointType	timePoint,
		bool	addMode
	)

protected

Generates an updated slice image with the contour applied.

Parameters

[in]	seg	The segmentation from which to extract the template slice.
[in]	sliceGeometry	Defines which slice to extract and update.
[in]	contour	The contour to rasterize into the slice.
[in]	labelValue	The label value to write.
[in]	timePoint	The time point for slice extraction.
[in]	addMode	If false, the contour area is set to background. If true, the label is added.

Returns: The updated slice image.

◆ GetFeedbackContour()

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

protected

◆ InitializeFeedbackContour()

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

protected

(Re)initialize the feedback 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() [1/2]

void mitk::FeedbackContourTool::SetFeedbackContourColor ( const Color & color )

protected

◆ SetFeedbackContourColor() [2/2]

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

◆ SetFeedbackContourWidth()

void mitk::FeedbackContourTool::SetFeedbackContourWidth ( float width )

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 existing 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 existing 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,
		MultiLabelSegmentation::LabelValueType	labelValue,
		bool	addMode,
		bool	setInvisibleAfterSuccess = `true`
	)

protected

Checks preconditions and writes the feedback contour as a segmentation result.

Steps: (1) gets the contour at the time point from positionEvent; (2) gets the affected working slice; (3) projects the contour onto the working slice and fills it; (4) writes the slice back via SegTool2D::WriteBackSegmentationResult().

Parameters

[in]	positionEvent	The position event that triggers the segmentation update.
[in]	labelValue	The label value to be written.
[in]	addMode	If false, the contour area is set to background (erased). If true, the label is added to the slice.
[in]	setInvisibleAfterSuccess	If true, hides the feedback contour after successful write.

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

mitkFeedbackContourTool.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FeedbackContourTool()

◆ ~FeedbackContourTool()

Member Function Documentation

◆ Activated()

◆ AddVertexToCurrentFeedbackContour()

◆ AddVertexToFeedbackContour()

◆ BackProjectContourFrom2DSlice()

◆ ClearsCurrentFeedbackContour()

◆ Deactivated()

◆ GenerateSliceWithContourUpdate()

◆ GetFeedbackContour()

◆ InitializeFeedbackContour()

◆ mitkClassMacro()

◆ ProjectContourTo2DSlice()

◆ SetFeedbackContourColor() [1/2]

◆ SetFeedbackContourColor() [2/2]

◆ SetFeedbackContourColorDefault()

◆ SetFeedbackContourVisible()

◆ SetFeedbackContourWidth()

◆ UpdateCurrentFeedbackContour()

◆ UpdateFeedbackContour()

◆ WriteBackFeedbackContourAsSegmentationResult()