Medical Imaging Interaction Toolkit  2018.4.99-0d336d68
Medical Imaging Interaction Toolkit
mitk::PickingTool Class Reference

Extracts a single region from a segmentation image and creates a new image with same geometry of the input image. More...

#include <mitkPickingTool.h>

Inheritance diagram for mitk::PickingTool:
Collaboration diagram for mitk::PickingTool:

Public Member Functions

 mitkClassMacro (PickingTool, AutoSegmentationTool)
 
Pointer Clone () const
 
const char ** GetXPM () const override
 Returns an icon in the XPM format. More...
 
const char * GetName () const override
 Returns the name of this tool. Make it short! More...
 
us::ModuleResource GetIconResource () const override
 Returns the tool button icon of the tool wrapped by a usModuleResource. More...
 
void Activated () override
 Called when the tool gets activated. More...
 
void Deactivated () override
 Called when the tool gets deactivated. More...
 
virtual DataNode::Pointer GetPointSetNode ()
 
mitk::DataNodeGetReferenceData ()
 
mitk::DataNodeGetWorkingData ()
 
mitk::DataStorageGetDataStorage ()
 
void ConfirmSegmentation ()
 
- Public Member Functions inherited from mitk::AutoSegmentationTool
 mitkClassMacro (AutoSegmentationTool, Tool)
 
void SetOverwriteExistingSegmentation (bool overwrite)
 
std::string GetCurrentSegmentationName ()
 Gets the name of the currently selected segmentation node. More...
 
virtual mitk::DataNodeGetTargetSegmentationNode ()
 Depending on the selected mode either returns the currently selected segmentation or creates a new one from the selected reference data and adds the new segmentation to the datastorage. More...
 
- 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 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
 

Static Public Member Functions

static Pointer New ()
 
- 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 Member Functions

 PickingTool ()
 
 ~PickingTool () override
 
void OnPointAdded ()
 
template<typename TPixel , unsigned int VImageDimension>
void StartRegionGrowing (itk::Image< TPixel, VImageDimension > *itkImage, mitk::BaseGeometry *imageGeometry, mitk::PointSet::PointType seedPoint)
 
- Protected Member Functions inherited from mitk::AutoSegmentationTool
 AutoSegmentationTool ()
 
 ~AutoSegmentationTool () override
 
const char * GetGroup () const override
 Name of a group. 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

long m_PointSetAddObserverTag
 
mitk::DataNode::Pointer m_ResultNode
 
PointSet::Pointer m_PointSet
 
SinglePointDataInteractor::Pointer m_SeedPointInteractor
 
DataNode::Pointer m_PointSetNode
 
DataNodem_WorkingData
 
- Protected Attributes inherited from mitk::AutoSegmentationTool
bool m_OverwriteExistingSegmentation
 
- 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
 
- 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::AutoSegmentationTool
static Image::ConstPointer GetImageByTimeStep (const Image *image, unsigned int timestep)
 
static Image::ConstPointer GetImageByTimePoint (const Image *image, TimePointType timePoint)
 

Detailed Description

Extracts a single region from a segmentation image and creates a new image with same geometry of the input image.

The region is extracted in 3D space. This is done by performing region growing within the desired region. Use shift click to add the seed point.

See also
mitk::Tool
QmitkInteractiveSegmentation

Definition at line 43 of file mitkPickingTool.h.

Constructor & Destructor Documentation

◆ PickingTool()

mitk::PickingTool::PickingTool ( )
protected

◆ ~PickingTool()

mitk::PickingTool::~PickingTool ( )
overrideprotected

Member Function Documentation

◆ Activated()

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

◆ Clone()

Pointer mitk::PickingTool::Clone ( ) const

◆ ConfirmSegmentation()

void mitk::PickingTool::ConfirmSegmentation ( )

◆ Deactivated()

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

◆ GetDataStorage()

mitk::DataStorage* mitk::PickingTool::GetDataStorage ( )

◆ GetIconResource()

us::ModuleResource mitk::PickingTool::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.

◆ GetName()

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

◆ GetPointSetNode()

virtual DataNode::Pointer mitk::PickingTool::GetPointSetNode ( )
virtual

◆ GetReferenceData()

mitk::DataNode* mitk::PickingTool::GetReferenceData ( )

◆ GetWorkingData()

mitk::DataNode* mitk::PickingTool::GetWorkingData ( )

◆ GetXPM()

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

◆ mitkClassMacro()

mitk::PickingTool::mitkClassMacro ( PickingTool  ,
AutoSegmentationTool   
)

◆ New()

static Pointer mitk::PickingTool::New ( )
static

◆ OnPointAdded()

void mitk::PickingTool::OnPointAdded ( )
protected

◆ StartRegionGrowing()

template<typename TPixel , unsigned int VImageDimension>
void mitk::PickingTool::StartRegionGrowing ( itk::Image< TPixel, VImageDimension > *  itkImage,
mitk::BaseGeometry imageGeometry,
mitk::PointSet::PointType  seedPoint 
)
protected

Member Data Documentation

◆ m_PointSet

PointSet::Pointer mitk::PickingTool::m_PointSet
protected

Definition at line 84 of file mitkPickingTool.h.

◆ m_PointSetAddObserverTag

long mitk::PickingTool::m_PointSetAddObserverTag
protected

Definition at line 73 of file mitkPickingTool.h.

◆ m_PointSetNode

DataNode::Pointer mitk::PickingTool::m_PointSetNode
protected

Definition at line 86 of file mitkPickingTool.h.

◆ m_ResultNode

mitk::DataNode::Pointer mitk::PickingTool::m_ResultNode
protected

Definition at line 75 of file mitkPickingTool.h.

◆ m_SeedPointInteractor

SinglePointDataInteractor::Pointer mitk::PickingTool::m_SeedPointInteractor
protected

Definition at line 85 of file mitkPickingTool.h.

◆ m_WorkingData

DataNode* mitk::PickingTool::m_WorkingData
protected

Definition at line 88 of file mitkPickingTool.h.


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