Medical Imaging Interaction Toolkit  2018.4.99-cfdaacfc
Medical Imaging Interaction Toolkit
mitk::BinaryThresholdTool Class Reference

Calculates the segmented volumes for binary images. More...

#include <mitkBinaryThresholdTool.h>

Inheritance diagram for mitk::BinaryThresholdTool:
Collaboration diagram for mitk::BinaryThresholdTool:

Public Member Functions

 mitkClassMacro (BinaryThresholdTool, AutoSegmentationTool)
 
Pointer Clone () const
 
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...
 
const char * GetName () const override
 Returns the name of this tool. Make it short! More...
 
void Activated () override
 Called when the tool gets activated. More...
 
void Deactivated () override
 Called when the tool gets deactivated. More...
 
virtual void SetThresholdValue (double value)
 
virtual void AcceptCurrentThresholdValue ()
 
virtual void CancelThresholding ()
 
- 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 (BaseData *referenceData) 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 ()
 

Public Attributes

Message3< double, double, bool > IntervalBordersChanged
 
Message1< double > ThresholdingValueChanged
 
- 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

 BinaryThresholdTool ()
 
 ~BinaryThresholdTool () override
 
void SetupPreviewNode ()
 
void CreateNewSegmentationFromThreshold (DataNode *node)
 
void OnRoiDataChanged ()
 
void UpdatePreview ()
 
template<typename TPixel , unsigned int VImageDimension>
void ITKThresholding (itk::Image< TPixel, VImageDimension > *originalImage, mitk::Image *segmentation, double thresholdValue, unsigned int timeStep)
 
template<typename TPixel , unsigned int VImageDimension>
void ITKThresholdingOldBinary (itk::Image< TPixel, VImageDimension > *originalImage, mitk::Image *segmentation, double thresholdValue, unsigned int timeStep)
 
- Protected Member Functions inherited from mitk::AutoSegmentationTool
 AutoSegmentationTool ()
 
 ~AutoSegmentationTool () override
 
const char * GetGroup () const override
 Name of a group. More...
 
virtual itk::SmartPointer< ImageGet3DImage (itk::SmartPointer< Image > image, unsigned int timestep)
 
- 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

DataNode::Pointer m_ThresholdFeedbackNode
 
DataNode::Pointer m_OriginalImageNode
 
DataNode::Pointer m_NodeForThresholding
 
double m_SensibleMinimumThresholdValue
 
double m_SensibleMaximumThresholdValue
 
double m_CurrentThresholdValue
 
bool m_IsFloatImage
 
bool m_IsOldBinary
 
- 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
 
- Protected Types inherited from mitk::EventStateMachine
typedef MessageAbstractDelegate2< StateMachineAction *, InteractionEvent *, void > ActionFunctionDelegate
 
typedef MessageAbstractDelegate1< const InteractionEvent *, bool > ConditionFunctionDelegate
 

Detailed Description

Calculates the segmented volumes for binary images.

See also
mitk::Tool
QmitkInteractiveSegmentation

Last contributor: $Author$

Definition at line 39 of file mitkBinaryThresholdTool.h.

Constructor & Destructor Documentation

◆ BinaryThresholdTool()

mitk::BinaryThresholdTool::BinaryThresholdTool ( )
protected

◆ ~BinaryThresholdTool()

mitk::BinaryThresholdTool::~BinaryThresholdTool ( )
overrideprotected

Definition at line 60 of file mitkBinaryThresholdTool.cpp.

Member Function Documentation

◆ AcceptCurrentThresholdValue()

◆ Activated()

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

Definition at line 81 of file mitkBinaryThresholdTool.cpp.

References mitk::ToolManager::ActivateTool(), mitk::ToolManager::GetReferenceData(), m_NodeForThresholding, m_OriginalImageNode, mitk::Tool::m_ToolManager, OnRoiDataChanged(), mitk::ToolManager::RoiDataChanged, and SetupPreviewNode().

◆ CancelThresholding()

void mitk::BinaryThresholdTool::CancelThresholding ( )
virtual

◆ Clone()

Pointer mitk::BinaryThresholdTool::Clone ( ) const

◆ CreateNewSegmentationFromThreshold()

◆ Deactivated()

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

Definition at line 101 of file mitkBinaryThresholdTool.cpp.

References mitk::ToolManager::GetDataStorage(), mitk::RenderingManager::GetInstance(), m_NodeForThresholding, m_OriginalImageNode, m_ThresholdFeedbackNode, mitk::Tool::m_ToolManager, OnRoiDataChanged(), mitk::RenderingManager::RequestUpdateAll(), and mitk::ToolManager::RoiDataChanged.

◆ GetIconResource()

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

Definition at line 69 of file mitkBinaryThresholdTool.cpp.

References ModuleContext::GetModule(), us::GetModuleContext(), and us::Module::GetResource().

◆ GetName()

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

Definition at line 76 of file mitkBinaryThresholdTool.cpp.

◆ GetXPM()

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

Definition at line 64 of file mitkBinaryThresholdTool.cpp.

◆ ITKThresholding()

template<typename TPixel , unsigned int VImageDimension>
void mitk::BinaryThresholdTool::ITKThresholding ( itk::Image< TPixel, VImageDimension > *  originalImage,
mitk::Image segmentation,
double  thresholdValue,
unsigned int  timeStep 
)
protected

◆ ITKThresholdingOldBinary()

template<typename TPixel , unsigned int VImageDimension>
void mitk::BinaryThresholdTool::ITKThresholdingOldBinary ( itk::Image< TPixel, VImageDimension > *  originalImage,
mitk::Image segmentation,
double  thresholdValue,
unsigned int  timeStep 
)
protected

◆ mitkClassMacro()

mitk::BinaryThresholdTool::mitkClassMacro ( BinaryThresholdTool  ,
AutoSegmentationTool   
)

◆ New()

static Pointer mitk::BinaryThresholdTool::New ( )
static

◆ OnRoiDataChanged()

◆ SetThresholdValue()

void mitk::BinaryThresholdTool::SetThresholdValue ( double  value)
virtual

◆ SetupPreviewNode()

◆ UpdatePreview()

Member Data Documentation

◆ IntervalBordersChanged

Message3<double, double, bool> mitk::BinaryThresholdTool::IntervalBordersChanged

Definition at line 42 of file mitkBinaryThresholdTool.h.

Referenced by SetupPreviewNode().

◆ m_CurrentThresholdValue

double mitk::BinaryThresholdTool::m_CurrentThresholdValue
protected

Definition at line 87 of file mitkBinaryThresholdTool.h.

Referenced by SetThresholdValue(), SetupPreviewNode(), and UpdatePreview().

◆ m_IsFloatImage

bool mitk::BinaryThresholdTool::m_IsFloatImage
protected

Definition at line 88 of file mitkBinaryThresholdTool.h.

Referenced by SetupPreviewNode().

◆ m_IsOldBinary

bool mitk::BinaryThresholdTool::m_IsOldBinary
protected

Definition at line 90 of file mitkBinaryThresholdTool.h.

Referenced by SetupPreviewNode(), and UpdatePreview().

◆ m_NodeForThresholding

DataNode::Pointer mitk::BinaryThresholdTool::m_NodeForThresholding
protected

◆ m_OriginalImageNode

DataNode::Pointer mitk::BinaryThresholdTool::m_OriginalImageNode
protected

◆ m_SensibleMaximumThresholdValue

double mitk::BinaryThresholdTool::m_SensibleMaximumThresholdValue
protected

◆ m_SensibleMinimumThresholdValue

double mitk::BinaryThresholdTool::m_SensibleMinimumThresholdValue
protected

Definition at line 85 of file mitkBinaryThresholdTool.h.

Referenced by OnRoiDataChanged(), SetThresholdValue(), and SetupPreviewNode().

◆ m_ThresholdFeedbackNode

DataNode::Pointer mitk::BinaryThresholdTool::m_ThresholdFeedbackNode
protected

◆ ThresholdingValueChanged

Message1<double> mitk::BinaryThresholdTool::ThresholdingValueChanged

Definition at line 43 of file mitkBinaryThresholdTool.h.

Referenced by SetupPreviewNode().


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