Superclass for tool that create a new segmentation without user interaction in render windows. More...

#include <mitkAutoSegmentationTool.h>

Inheritance diagram for mitk::AutoSegmentationTool:

[legend]

Collaboration diagram for mitk::AutoSegmentationTool:

[legend]

Public Member Functions
	mitkClassMacro (AutoSegmentationTool, Tool)

void	Activated () override
	Called when the tool gets activated. More...

void	Deactivated () override
	Called when the tool gets deactivated. More...

void	SetOverwriteExistingSegmentation (bool overwrite)

std::string	GetCurrentSegmentationName ()
	Gets the name of the currently selected segmentation node. More...

virtual DataNode *	GetTargetSegmentationNode () const
	Depending on the selected mode either returns the currently selected segmentation node or (if overwrite mode is false) creates a new one from the selected reference data. 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 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
	AutoSegmentationTool ()

	AutoSegmentationTool (const char interactorType, const us::Module interactorModule=nullptr)

	~AutoSegmentationTool () override

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

void	EnsureTargetSegmentationNodeInDataStorage () const

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 (if modified by the SlicesCoordinator) 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 ()

Static Protected Member Functions
static Image::ConstPointer	GetImageByTimeStep (const Image *image, unsigned int timestep)

static Image::Pointer	GetImageByTimeStep (Image *image, unsigned int timestep)

static Image::ConstPointer	GetImageByTimePoint (const Image *image, TimePointType timePoint)

Protected Attributes
bool	m_OverwriteExistingSegmentation

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::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

Detailed Description

Superclass for tool that create a new segmentation without user interaction in render windows.

This class is undocumented. Ask the creator ($Author$) to supply useful comments.

Definition at line 29 of file mitkAutoSegmentationTool.h.

Constructor & Destructor Documentation

◆ AutoSegmentationTool() [1/2]

mitk::AutoSegmentationTool::AutoSegmentationTool ( )

protected

◆ AutoSegmentationTool() [2/2]

mitk::AutoSegmentationTool::AutoSegmentationTool	(	const char *	interactorType,
		const us::Module *	interactorModule = `nullptr`
	)

protected

◆ ~AutoSegmentationTool()

mitk::AutoSegmentationTool::~AutoSegmentationTool ( )

overrideprotected

Member Function Documentation

◆ Activated()

void mitk::AutoSegmentationTool::Activated ( )

overridevirtual

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::nnUNetTool, mitk::PickingTool, mitk::AutoSegmentationWithPreviewTool, and mitk::OtsuTool3D.

◆ Deactivated()

void mitk::AutoSegmentationTool::Deactivated ( )

overridevirtual

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

◆ EnsureTargetSegmentationNodeInDataStorage()

void mitk::AutoSegmentationTool::EnsureTargetSegmentationNodeInDataStorage ( ) const

protected

◆ GetCurrentSegmentationName()

std::string mitk::AutoSegmentationTool::GetCurrentSegmentationName ( )

Gets the name of the currently selected segmentation node.

Returns: the name of the segmentation node or an empty string if none is selected

◆ GetGroup()

const char* mitk::AutoSegmentationTool::GetGroup ( ) const

overrideprotectedvirtual

Name of a group.

You can group several tools by assigning a group name. Graphical tool selectors might use this information to group tools. (What other reason could there be?)

Reimplemented from mitk::Tool.

◆ GetImageByTimePoint()

static Image::ConstPointer mitk::AutoSegmentationTool::GetImageByTimePoint	(	const Image *	image,
		TimePointType	timePoint
	)

staticprotected

Helper that extracts the image for the passed time point, if the image has multiple time steps.

◆ GetImageByTimeStep() [1/2]

static Image::ConstPointer mitk::AutoSegmentationTool::GetImageByTimeStep	(	const Image *	image,
		unsigned int	timestep
	)

staticprotected

Helper that extracts the image for the passed timestep, if the image has multiple time steps.

◆ GetImageByTimeStep() [2/2]

static Image::Pointer mitk::AutoSegmentationTool::GetImageByTimeStep	(	Image *	image,
		unsigned int	timestep
	)

staticprotected

Helper that extracts the image for the passed timestep, if the image has multiple time steps.

◆ GetTargetSegmentationNode()

virtual DataNode* mitk::AutoSegmentationTool::GetTargetSegmentationNode ( ) const

virtual

Depending on the selected mode either returns the currently selected segmentation node or (if overwrite mode is false) creates a new one from the selected reference data.

Remarks: Please keep in mind that new created nodes are not automatically added to the data storage. Derived tools can call EnsureTargetSegmentationNodeInDataStorage to ensure it as soon as it is clear that the target segmentation node will be/is confirmed.

Returns: a mitk::DataNode which contains a segmentation image

◆ mitkClassMacro()

mitk::AutoSegmentationTool::mitkClassMacro	(	AutoSegmentationTool	,
		Tool
	)

◆ SetOverwriteExistingSegmentation()

void mitk::AutoSegmentationTool::SetOverwriteExistingSegmentation ( bool overwrite )

This function controls wether a confirmed segmentation should replace the old segmentation/working node (true) or if it should be stored as new and additional node (false).

Member Data Documentation

◆ m_OverwriteExistingSegmentation

bool mitk::AutoSegmentationTool::m_OverwriteExistingSegmentation

protected

Definition at line 76 of file mitkAutoSegmentationTool.h.

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

mitkAutoSegmentationTool.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AutoSegmentationTool() [1/2]

◆ AutoSegmentationTool() [2/2]

◆ ~AutoSegmentationTool()

Member Function Documentation

◆ Activated()

◆ Deactivated()

◆ EnsureTargetSegmentationNodeInDataStorage()

◆ GetCurrentSegmentationName()

◆ GetGroup()

◆ GetImageByTimePoint()

◆ GetImageByTimeStep() [1/2]

◆ GetImageByTimeStep() [2/2]

◆ GetTargetSegmentationNode()

◆ mitkClassMacro()

◆ SetOverwriteExistingSegmentation()

Member Data Documentation

◆ m_OverwriteExistingSegmentation