#include <mitknnInteractiveTool.h>

Inheritance diagram for mitk::nnInteractiveTool:

[legend]

Collaboration diagram for mitk::nnInteractiveTool:

[legend]

Classes
struct	CUDADeviceInfo

Public Types
using	InteractorMap = std::unordered_map< nnInteractive::InteractionType, std::unique_ptr< nnInteractive::Interactor > >

Public Types inherited from mitk::SegWithPreviewTool
enum	LabelTransferScope { LabelTransferScope::ActiveLabel, LabelTransferScope::SelectedLabels, LabelTransferScope::AllLabels }

enum	LabelTransferMode { LabelTransferMode::MapLabel, LabelTransferMode::AddLabel }

using	SelectedLabelVectorType = std::vector< Label::PixelType >

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

Public Member Functions
	mitkClassMacro (nnInteractiveTool, SegWithPreviewTool) static Pointer New()

const char *	GetName () const override
	Returns the name of this tool. Make it short! More...

const char **	GetXPM () const override
	Returns an icon in the XPM format. More...

us::ModuleResource	GetIconResource () const override
	Returns the tool button icon of the tool wrapped by a usModuleResource. More...

bool	CanHandle (const BaseData referenceData, const BaseData workingData) const override

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

const InteractorMap &	GetInteractors () const

const nnInteractive::Interactor *	GetInteractor (nnInteractive::InteractionType interactionType) const

void	EnableInteractor (nnInteractive::InteractionType nextInteractionType, nnInteractive::PromptType promptType)

void	DisableInteractor (std::optional< nnInteractive::InteractionType > interactionType=std::nullopt)

void	ResetInteractions ()

bool	HasInteractions () const

bool	GetAutoZoom () const

void	SetAutoZoom (bool autoZoom)

bool	GetAutoRefine () const

void	SetAutoRefine (bool autoRefine)

std::optional< nnInteractive::Backend >	GetBackend () const

std::string	GetVirtualEnvName () const

bool	CreatePythonContext ()

PythonContext *	GetPythonContext () const

bool	IsInstalled () const

bool	GetCUDADeviceInfo (CUDADeviceInfo &info) const

void	StartSession ()

void	EndSession ()

bool	IsSessionRunning () const

void	InitializeSessionWithMask (Image *mask)

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

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

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

void	ConfirmSegmentation ()

virtual void	SetCreateAllTimeSteps (bool _arg)

virtual bool	GetCreateAllTimeSteps ()

virtual void	CreateAllTimeStepsOn ()

virtual void	CreateAllTimeStepsOff ()

virtual void	SetKeepActiveAfterAccept (bool _arg)

virtual bool	GetKeepActiveAfterAccept ()

virtual void	KeepActiveAfterAcceptOn ()

virtual void	KeepActiveAfterAcceptOff ()

virtual void	SetIsTimePointChangeAware (bool _arg)

virtual bool	GetIsTimePointChangeAware ()

virtual void	IsTimePointChangeAwareOn ()

virtual void	IsTimePointChangeAwareOff ()

virtual void	SetResetsToEmptyPreview (bool _arg)

virtual bool	GetResetsToEmptyPreview ()

virtual void	ResetsToEmptyPreviewOn ()

virtual void	ResetsToEmptyPreviewOff ()

virtual void	SetUseSpecialPreviewColor (bool _arg)

virtual bool	GetUseSpecialPreviewColor ()

virtual void	UseSpecialPreviewColorOn ()

virtual void	UseSpecialPreviewColorOff ()

virtual void	SetRequestDeactivationConfirmation (bool _arg)

virtual bool	GetRequestDeactivationConfirmation ()

virtual void	RequestDeactivationConfirmationOn ()

virtual void	RequestDeactivationConfirmationOff ()

void	SetMergeStyle (MultiLabelSegmentation::MergeStyle mergeStyle)

virtual MultiLabelSegmentation::MergeStyle	GetMergeStyle ()

void	SetOverwriteStyle (MultiLabelSegmentation::OverwriteStyle overwriteStyle)

virtual MultiLabelSegmentation::OverwriteStyle	GetOverwriteStyle ()

void	SetLabelTransferScope (LabelTransferScope labelTransferScope)

virtual LabelTransferScope	GetLabelTransferScope ()

void	SetSelectedLabels (const SelectedLabelVectorType &labelsToTransfer)

virtual SelectedLabelVectorType	GetSelectedLabels ()

void	SetLabelTransferMode (LabelTransferMode labelTransferMode)

virtual LabelTransferMode	GetLabelTransferMode ()

bool	CanHandle (const BaseData referenceData, const BaseData workingData) const override

void	UpdatePreview (bool ignoreLazyPreviewSetting=false)

bool	IsUpdating () const

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

virtual DataNode *	GetTargetSegmentationNode () const
	Returns the currently selected segmentation node. More...

MultiLabelSegmentation *	GetTargetSegmentation () const

MultiLabelSegmentation *	GetPreviewSegmentation ()

const MultiLabelSegmentation *	GetPreviewSegmentation () const

DataNode *	GetPreviewSegmentationNode ()

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

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 bool	IsEligibleForAutoInit () const
	Returns whether this tool is eligible for auto-initialization by ToolManager. 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

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< bool >	ConfirmCleanUpEvent

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

	~nnInteractiveTool () override

void	SetToolManager (ToolManager *toolManager) override

void	DoUpdatePreview (const Image inputAtTimeStep, const Image oldSegAtTimeStep, MultiLabelSegmentation *previewImage, TimeStepType timeStep) override

void	Notify (InteractionEvent *event, bool isHandled) override

void	ConfirmCleanUp () override

Protected Member Functions inherited from mitk::SegWithPreviewTool
	SegWithPreviewTool (bool lazyDynamicPreviews=false)

	SegWithPreviewTool (bool lazyDynamicPreviews, const char interactorType, const us::Module interactorModule=nullptr)

	~SegWithPreviewTool () override

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

void	EnsureTargetSegmentationNodeInDataStorage () const

virtual void	InitiateToolByInput ()

virtual void	UpdatePrepare ()

virtual void	UpdateCleanUp ()

virtual void	PreparePreviewToResultTransfer (const LabelMappingType &labelMapping)

const Image *	GetSegmentationInput () const

const Image *	GetReferenceData () const

void	ResetPreviewNode ()

void	ResetPreviewContent ()

void	ResetPreviewContentAtTimeStep (unsigned int timeStep)

TimePointType	GetLastTimePointOfUpdate () const

MultiLabelSegmentation::LabelValueType	GetActiveLabelValueOfPreview () const

virtual Label::PixelType	GetUserDefinedActiveLabel () const

virtual void	SetWorkingPlaneGeometry (PlaneGeometry *_arg)

virtual const PlaneGeometry *	GetWorkingPlaneGeometry ()

bool	ConfirmBeforeDeactivation () override
	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...

Protected Member Functions inherited from mitk::Tool
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 ()

Additional Inherited Members
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::SegWithPreviewTool
using	LabelMappingType = std::vector< std::pair< Label::PixelType, Label::PixelType > >

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::SegWithPreviewTool
static Image::ConstPointer	GetImageByTimeStep (const Image *image, TimeStepType timestep)

static Image::Pointer	GetImageByTimeStep (Image *image, TimeStepType timestep)

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

static void	TransferLabelInformation (const LabelMappingType &labelMapping, const mitk::MultiLabelSegmentation source, mitk::MultiLabelSegmentation target)

Protected Attributes inherited from mitk::SegWithPreviewTool
ToolCommand::Pointer	m_ProgressCommand

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

Definition at line 30 of file mitknnInteractiveTool.h.

Member Typedef Documentation

◆ InteractorMap

using mitk::nnInteractiveTool::InteractorMap = std::unordered_map<nnInteractive::InteractionType, std::unique_ptr<nnInteractive::Interactor> >

Definition at line 50 of file mitknnInteractiveTool.h.

Constructor & Destructor Documentation

◆ nnInteractiveTool()

mitk::nnInteractiveTool::nnInteractiveTool ( )

protected

◆ ~nnInteractiveTool()

mitk::nnInteractiveTool::~nnInteractiveTool ( )

overrideprotected

Member Function Documentation

◆ CanHandle()

bool mitk::nnInteractiveTool::CanHandle	(	const BaseData *	referenceData,
		const BaseData *	workingData
	)		const

overridevirtual

Function used to check if a tool can handle the referenceData and (if specified) the working data.

Precondition: referenceData must be a valid pointer

Parameters

referenceData	Pointer to the data that should be checked as valid reference for the tool.
workingData	Pointer to the data that should be checked as valid working data for this tool. This parameter can be null if no working data is specified so far.

Reimplemented from mitk::Tool.

◆ ConfirmCleanUp()

void mitk::nnInteractiveTool::ConfirmCleanUp ( )

overrideprotectedvirtual

This member function offers derived classes the possibility to alter what should happen directly after the Confirmation of the preview is performed. It is called by ConfirmSegmentation. Default implementation does nothing.

Reimplemented from mitk::SegWithPreviewTool.

◆ CreatePythonContext()

bool mitk::nnInteractiveTool::CreatePythonContext ( )

◆ Deactivated()

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

◆ DisableInteractor()

void mitk::nnInteractiveTool::DisableInteractor ( std::optional< nnInteractive::InteractionType > interactionType = std::nullopt )

◆ DoUpdatePreview()

void mitk::nnInteractiveTool::DoUpdatePreview	(	const Image *	inputAtTimeStep,
		const Image *	oldSegAtTimeStep,
		MultiLabelSegmentation *	previewImage,
		TimeStepType	timeStep
	)

overrideprotectedvirtual

This function does the real work. Here the preview for a given input image should be computed and stored in the also passed preview image at the passed time step. It also provides the current/old segmentation at the time point, which can be used, if the preview depends on the the segmentation so far.

Implements mitk::SegWithPreviewTool.

◆ EnableInteractor()

void mitk::nnInteractiveTool::EnableInteractor	(	nnInteractive::InteractionType	nextInteractionType,
		nnInteractive::PromptType	promptType
	)

◆ EndSession()

void mitk::nnInteractiveTool::EndSession ( )

◆ GetAutoRefine()

bool mitk::nnInteractiveTool::GetAutoRefine ( ) const

◆ GetAutoZoom()

bool mitk::nnInteractiveTool::GetAutoZoom ( ) const

◆ GetBackend()

std::optional<nnInteractive::Backend> mitk::nnInteractiveTool::GetBackend ( ) const

◆ GetCUDADeviceInfo()

bool mitk::nnInteractiveTool::GetCUDADeviceInfo ( CUDADeviceInfo & info ) const

◆ GetIconResource()

us::ModuleResource mitk::nnInteractiveTool::GetIconResource ( ) const

overridevirtual

Returns the tool button icon of the tool wrapped by a usModuleResource.

Returns: a valid ModuleResource or an invalid if this function is not reimplemented

Reimplemented from mitk::Tool.

◆ GetInteractor()

const nnInteractive::Interactor* mitk::nnInteractiveTool::GetInteractor ( nnInteractive::InteractionType interactionType ) const

◆ GetInteractors()

const InteractorMap& mitk::nnInteractiveTool::GetInteractors ( ) const

◆ GetName()

const char* mitk::nnInteractiveTool::GetName ( ) const

overridevirtual

Returns the name of this tool. Make it short!

This name has to fit into some kind of button in most applications, so take some time to think of a good name!

Implements mitk::Tool.

◆ GetPythonContext()

PythonContext* mitk::nnInteractiveTool::GetPythonContext ( ) const

◆ GetVirtualEnvName()

std::string mitk::nnInteractiveTool::GetVirtualEnvName ( ) const

◆ GetXPM()

const char** mitk::nnInteractiveTool::GetXPM ( ) const

overridevirtual

Returns an icon in the XPM format.

This icon has to fit into some kind of button in most applications, so make it smaller than 25x25 pixels.

XPM is e.g. supported by The Gimp. But if you open any XPM file in your text editor, you will see that you could also "draw" it with an editor.

Implements mitk::Tool.

◆ HasInteractions()

bool mitk::nnInteractiveTool::HasInteractions ( ) const

◆ InitializeSessionWithMask()

void mitk::nnInteractiveTool::InitializeSessionWithMask ( Image * mask )

◆ IsInstalled()

bool mitk::nnInteractiveTool::IsInstalled ( ) const

◆ IsSessionRunning()

bool mitk::nnInteractiveTool::IsSessionRunning ( ) const

◆ mitkClassMacro()

mitk::nnInteractiveTool::mitkClassMacro	(	nnInteractiveTool	,
		SegWithPreviewTool
	)

◆ Notify()

void mitk::nnInteractiveTool::Notify	(	InteractionEvent *	interactionEvent,
		bool	isHandled
	)

overrideprotectedvirtual

By this method all registered EventObersers are notified about every InteractionEvent, the isHandled flag indicates if a DataInteractor has already handled that event. InteractionEventObserver that trigger an action when observing an event may consider this in order to not confuse the user by, triggering several independent action with one single user event (such as a mouse click)

If you want to use the InteractionEventObserver as a state machine give the event to the state machine by implementing, e.g.

void mitk::InteractionEventObserver::Notify(InteractionEvent::Pointer interactionEvent, bool isHandled)
 {
   if (!isHandled) {
     this->HandleEvent(interactionEvent, nullptr);
   }
 }

This overwrites the FilterEvents function of the EventStateMachine to ignore the DataNode, since InteractionEventObservers are not associated with one. virtual bool FilterEvents(InteractionEvent* interactionEvent, DataNode* dataNode);

Implements mitk::InteractionEventObserver.

◆ ResetInteractions()

void mitk::nnInteractiveTool::ResetInteractions ( )

◆ SetAutoRefine()

void mitk::nnInteractiveTool::SetAutoRefine ( bool autoRefine )

◆ SetAutoZoom()

void mitk::nnInteractiveTool::SetAutoZoom ( bool autoZoom )

◆ SetToolManager()

void mitk::nnInteractiveTool::SetToolManager ( ToolManager * toolManager )

overrideprotectedvirtual

Reimplemented from mitk::Tool.

◆ StartSession()

void mitk::nnInteractiveTool::StartSession ( )

Member Data Documentation

◆ ConfirmCleanUpEvent

Message1<bool> mitk::nnInteractiveTool::ConfirmCleanUpEvent

Definition at line 77 of file mitknnInteractiveTool.h.

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

mitknnInteractiveTool.h

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InteractorMap

Constructor & Destructor Documentation

◆ nnInteractiveTool()

◆ ~nnInteractiveTool()

Member Function Documentation

◆ CanHandle()

◆ ConfirmCleanUp()

◆ CreatePythonContext()

◆ Deactivated()

◆ DisableInteractor()

◆ DoUpdatePreview()

◆ EnableInteractor()

◆ EndSession()

◆ GetAutoRefine()

◆ GetAutoZoom()

◆ GetBackend()

◆ GetCUDADeviceInfo()

◆ GetIconResource()

◆ GetInteractor()

◆ GetInteractors()

◆ GetName()

◆ GetPythonContext()

◆ GetVirtualEnvName()

◆ GetXPM()

◆ HasInteractions()

◆ InitializeSessionWithMask()

◆ IsInstalled()

◆ IsSessionRunning()

◆ mitkClassMacro()

◆ Notify()

◆ ResetInteractions()

◆ SetAutoRefine()

◆ SetAutoZoom()

◆ SetToolManager()

◆ StartSession()

Member Data Documentation

◆ ConfirmCleanUpEvent