Medical Imaging Interaction Toolkit  2018.04.99-74b4982f
Medical Imaging Interaction Toolkit
mitk::SegmentationsProcessingTool Class Reference

Batch processing of all selected segmentations/data. More...

#include <mitkSegmentationsProcessingTool.h>

Inheritance diagram for mitk::SegmentationsProcessingTool:
Collaboration diagram for mitk::SegmentationsProcessingTool:

Public Member Functions

 mitkClassMacro (SegmentationsProcessingTool, Tool)
 
- 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)
 
DataNode::Pointer CreateSegmentationNode (Image *image, const std::string &organName, const mitk::Color &color)
 
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

 SegmentationsProcessingTool ()
 
 ~SegmentationsProcessingTool () override
 
const char * GetGroup () const override
 Name of a group. More...
 
void Activated () override
 Called when the tool gets activated. More...
 
void Deactivated () override
 Called when the tool gets deactivated. More...
 
virtual void ProcessAllObjects ()
 Loop over all working data items. More...
 
virtual void StartProcessingAllData ()
 Subclasses should override this method. More...
 
virtual bool ProcessOneWorkingData (DataNode *node)
 Subclasses should override this method. More...
 
virtual void FinishProcessingAllData ()
 Subclasses should override this method. More...
 
virtual void SendErrorMessageIfAny ()
 Sends an error message if there was an error during processing. More...
 
virtual std::string GetErrorMessage ()
 Describes the error (if one occurred during processing). More...
 
- Protected Member Functions inherited from mitk::Tool
virtual void SetToolManager (ToolManager *)
 
void ConnectActionsAndFunctions () override
 
 Tool ()
 
 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 ()
 

Protected Attributes

std::string m_FailedNodes
 
- Protected Attributes inherited from mitk::Tool
std::string m_EventConfig
 Let subclasses change their event configuration. More...
 
ToolManagerm_ToolManager
 
- Protected Attributes inherited from mitk::EventStateMachine
bool m_IsActive
 
UndoControllerm_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< 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::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

Batch processing of all selected segmentations/data.

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

Definition at line 28 of file mitkSegmentationsProcessingTool.h.

Constructor & Destructor Documentation

◆ SegmentationsProcessingTool()

mitk::SegmentationsProcessingTool::SegmentationsProcessingTool ( )
protected

◆ ~SegmentationsProcessingTool()

mitk::SegmentationsProcessingTool::~SegmentationsProcessingTool ( )
overrideprotected

Member Function Documentation

◆ Activated()

void mitk::SegmentationsProcessingTool::Activated ( )
overrideprotectedvirtual

Called when the tool gets activated.

Will just call ProcessAllObjects and then deactivate this tool again.

Reimplemented from mitk::Tool.

◆ Deactivated()

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

◆ FinishProcessingAllData()

virtual void mitk::SegmentationsProcessingTool::FinishProcessingAllData ( )
protectedvirtual

Subclasses should override this method.

See also
ProcessAllObjects

Reimplemented in mitk::CalculateGrayValueStatisticsTool, and mitk::CalculateVolumetryTool.

◆ GetErrorMessage()

virtual std::string mitk::SegmentationsProcessingTool::GetErrorMessage ( )
protectedvirtual

Describes the error (if one occurred during processing).

Reimplemented in mitk::CalculateGrayValueStatisticsTool, mitk::CreateSurfaceTool, mitk::AutoCropTool, and mitk::CalculateVolumetryTool.

◆ GetGroup()

const char* mitk::SegmentationsProcessingTool::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.

◆ mitkClassMacro()

mitk::SegmentationsProcessingTool::mitkClassMacro ( SegmentationsProcessingTool  ,
Tool   
)

◆ ProcessAllObjects()

virtual void mitk::SegmentationsProcessingTool::ProcessAllObjects ( )
protectedvirtual

Loop over all working data items.

Will call the following methods in turn

Subclasses should override these methods as needed and provide meaningful implementations.

◆ ProcessOneWorkingData()

virtual bool mitk::SegmentationsProcessingTool::ProcessOneWorkingData ( DataNode node)
protectedvirtual

◆ SendErrorMessageIfAny()

virtual void mitk::SegmentationsProcessingTool::SendErrorMessageIfAny ( )
protectedvirtual

Sends an error message if there was an error during processing.

◆ StartProcessingAllData()

virtual void mitk::SegmentationsProcessingTool::StartProcessingAllData ( )
protectedvirtual

Subclasses should override this method.

See also
ProcessAllObjects

Reimplemented in mitk::CalculateGrayValueStatisticsTool.

Member Data Documentation

◆ m_FailedNodes

std::string mitk::SegmentationsProcessingTool::m_FailedNodes
protected

Definition at line 88 of file mitkSegmentationsProcessingTool.h.


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