mitk::FillRegionBaseTool Class Reference

Base class for tools that fill a connected region of a 2D slice. More...

#include <mitkFillRegionBaseTool.h>

Inheritance diagram for mitk::FillRegionBaseTool:

Collaboration diagram for mitk::FillRegionBaseTool:

Public Member Functions
	mitkClassMacro (FillRegionBaseTool, 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
virtual bool	ConfirmBeforeDeactivation ()
	Method call to invoke a dialog box just before exiting. The method can be reimplemented in the respective tool class with business logic on when there should be a confirmation dialog from the user before the tool exits. More...
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
	FillRegionBaseTool ()
	~FillRegionBaseTool () override
void	ConnectActionsAndFunctions () override
virtual void	OnClick (StateMachineAction *, InteractionEvent *interactionEvent)
	Add a control point and finish current segment. More...
virtual Image::Pointer	GenerateFillImage (const Image *workingSlice, Point3D seedPoint, mitk::Label::PixelType &seedLabelValue) const
virtual void	PrepareFilling (const Image *workingSlice, Point3D seedPoint)=0
Protected Member Functions inherited from mitk::SegTool2D
	SegTool2D ()
	SegTool2D (const char *, const us::Module *interactorModule=nullptr)
	~SegTool2D () override
DataNode *	GetWorkingDataNode () const
	returns the segmentation node that should be modified by the tool. More...
Image *	GetWorkingData () const
DataNode *	GetReferenceDataNode () const
Image *	GetReferenceData () 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 *)
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
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)
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 ()

Protected Attributes
Label::PixelType	m_FillLabelValue
Label::PixelType	m_SeedLabelValue
MultiLabelSegmentation::MergeStyle	m_MergeStyle
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

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< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef std::map< std::string, TActionFunctor * >	ActionFunctionsMapType
typedef itk::SmartPointer< StateMachineState >	StateMachineStateType
Public Types inherited from mitk::InteractionEventHandler
typedef InteractionEventHandler	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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 LabelSetImage *workingImage, TimeStepType timeStep, const PlaneGeometry *plane, bool detectIntersection)
	Updates the surface interpolations by extracting the contour form the given slice for all labels that have a surface contour information stored for the given plane at the given timestep. 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, mitk::Label::PixelType activeLabelValue, bool silent=false)
	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) mark the node as modified. More...
static void	WriteSliceToVolume (Image *workingImage, const SliceInformation &sliceInfo, bool allowUndo)
static bool	IsPositionEventInsideImageRegion (InteractionPositionEvent *positionEvent, const BaseData *data)

Detailed Description

Base class for tools that fill a connected region of a 2D slice.

See also

Tool

Warning

Only to be instantiated by mitk::ToolManager.

Author

nolden

Definition at line 41 of file mitkFillRegionBaseTool.h.

Constructor & Destructor Documentation

FillRegionBaseTool()

mitk::FillRegionBaseTool::FillRegionBaseTool ( )

protected

~FillRegionBaseTool()

mitk::FillRegionBaseTool::~FillRegionBaseTool ( )

overrideprotected

Member Function Documentation

ConnectActionsAndFunctions()

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

GenerateFillImage()

virtual Image::Pointer mitk::FillRegionBaseTool::GenerateFillImage ( const Image *  workingSlice, Point3D  seedPoint, mitk::Label::PixelType &  seedLabelValue  ) const

protectedvirtual

Function that generates the mask image that indicates which pixels should be filled. Caller of this function assumes that all pixels that should be filled have the value 1. Pixels that should stay untouched should have the value 0. The default implementation marks the connected reagion around seedPoint, that has the same pixel value/label like the seedPoint. You may reimplement this function to change the strategy to determine the fill region.

Parameters

	workingSlice	part of the segmentation image that should be used to determine the fill image.
	seedPoint	The world coordinate position where the user has cliced.
[out]	seedLabelValue	The function should return the label value that should be assumed as clicked on, given the seedPoint.

Returns

Return the image maske that indicates which pixels should be filled. Returning a null pointer indicates that there is nothing to fill.

Reimplemented in mitk::CloseRegionTool, and mitk::EraseRegionTool.

mitkClassMacro()

mitk::FillRegionBaseTool::mitkClassMacro	(	FillRegionBaseTool	,
		SegTool2D
	)

OnClick()

virtual void mitk::FillRegionBaseTool::OnClick ( StateMachineAction *  , InteractionEvent *  interactionEvent  )

protectedvirtual

Add a control point and finish current segment.

PrepareFilling()

virtual void mitk::FillRegionBaseTool::PrepareFilling ( const Image *  workingSlice, Point3D  seedPoint  )

protectedpure virtual

Function that is called by OnClick before the filling is executed. If you want to do special preparation (e.g. change m_FillLabelValue, you can overwrite this function.

Implemented in mitk::CloseRegionTool, mitk::EraseRegionTool, and mitk::FillRegionTool.

Member Data Documentation

m_FillLabelValue

Label::PixelType mitk::FillRegionBaseTool::m_FillLabelValue

protected

Definition at line 74 of file mitkFillRegionBaseTool.h.

m_MergeStyle

MultiLabelSegmentation::MergeStyle mitk::FillRegionBaseTool::m_MergeStyle

protected

Definition at line 77 of file mitkFillRegionBaseTool.h.

m_SeedLabelValue

Label::PixelType mitk::FillRegionBaseTool::m_SeedLabelValue

protected

Definition at line 75 of file mitkFillRegionBaseTool.h.

---

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

• mitkFillRegionBaseTool.h