Base class for binary threshold tools. More...

#include <mitkBinaryThresholdBaseTool.h>

Inheritance diagram for mitk::BinaryThresholdBaseTool:

[legend]

Collaboration diagram for mitk::BinaryThresholdBaseTool:

[legend]

Public Member Functions
	mitkClassMacro (BinaryThresholdBaseTool, SegWithPreviewTool)

virtual void	SetThresholdValues (double lower, double upper)

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

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

LabelSetImage *	GetTargetSegmentation () const

LabelSetImage *	GetPreviewSegmentation ()

const LabelSetImage *	GetPreviewSegmentation () const

DataNode *	GetPreviewSegmentationNode ()

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

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

Message2< ScalarType, ScalarType >	ThresholdingValuesChanged

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

	~BinaryThresholdBaseTool () override

virtual void	SetLockedUpperThreshold (bool _arg)

virtual bool	GetLockedUpperThreshold ()

virtual void	LockedUpperThresholdOn ()

virtual void	LockedUpperThresholdOff ()

virtual ScalarType	GetSensibleMinimumThreshold ()

virtual ScalarType	GetSensibleMaximumThreshold ()

void	InitiateToolByInput () override

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

template<typename TPixel , unsigned int VImageDimension>
void	ITKThresholding (const itk::Image< TPixel, VImageDimension > inputImage, LabelSetImage segmentation, unsigned int timeStep)

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

virtual void	UpdateCleanUp ()

virtual void	ConfirmCleanUp ()

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

LabelSetImage::LabelValueType	GetActiveLabelValueOfPreview () const

virtual Label::PixelType	GetUserDefinedActiveLabel () const

virtual void	SetWorkingPlaneGeometry (PlaneGeometry *_arg)

virtual const PlaneGeometry *	GetWorkingPlaneGeometry ()

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

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::LabelSetImage source, mitk::LabelSetImage target)

static void	TransferLabelSetImageContent (const LabelSetImage source, LabelSetImage target, TimeStepType timeStep)

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

Base class for binary threshold tools.

See also: mitk::Tool; QmitkInteractiveSegmentation

Definition at line 35 of file mitkBinaryThresholdBaseTool.h.

Constructor & Destructor Documentation

◆ BinaryThresholdBaseTool()

mitk::BinaryThresholdBaseTool::BinaryThresholdBaseTool ( )

protected

◆ ~BinaryThresholdBaseTool()

mitk::BinaryThresholdBaseTool::~BinaryThresholdBaseTool ( )

overrideprotected

Member Function Documentation

◆ DoUpdatePreview()

void mitk::BinaryThresholdBaseTool::DoUpdatePreview	(	const Image *	inputAtTimeStep,
		const Image *	oldSegAtTimeStep,
		LabelSetImage *	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 segmenation so far.

Implements mitk::SegWithPreviewTool.

◆ GetLockedUpperThreshold()

virtual bool mitk::BinaryThresholdBaseTool::GetLockedUpperThreshold ( )

protectedvirtual

◆ GetSensibleMaximumThreshold()

virtual ScalarType mitk::BinaryThresholdBaseTool::GetSensibleMaximumThreshold ( )

protectedvirtual

◆ GetSensibleMinimumThreshold()

virtual ScalarType mitk::BinaryThresholdBaseTool::GetSensibleMinimumThreshold ( )

protectedvirtual

◆ InitiateToolByInput()

void mitk::BinaryThresholdBaseTool::InitiateToolByInput ( )

overrideprotectedvirtual

Member is always called if GetSegmentationInput() has changed (e.g. because a new ROI was defined, or on activation) to give derived classes the posibility to initiate their state accordingly. Reimplement this function to implement special behavior.

Reimplemented from mitk::SegWithPreviewTool.

◆ ITKThresholding()

template<typename TPixel , unsigned int VImageDimension>

void mitk::BinaryThresholdBaseTool::ITKThresholding	(	const itk::Image< TPixel, VImageDimension > *	inputImage,
		LabelSetImage *	segmentation,
		unsigned int	timeStep
	)

protected

◆ LockedUpperThresholdOff()

virtual void mitk::BinaryThresholdBaseTool::LockedUpperThresholdOff ( )

protectedvirtual

◆ LockedUpperThresholdOn()

virtual void mitk::BinaryThresholdBaseTool::LockedUpperThresholdOn ( )

protectedvirtual

◆ mitkClassMacro()

mitk::BinaryThresholdBaseTool::mitkClassMacro	(	BinaryThresholdBaseTool	,
		SegWithPreviewTool
	)

◆ SetLockedUpperThreshold()

virtual void mitk::BinaryThresholdBaseTool::SetLockedUpperThreshold ( bool _arg )

protectedvirtual

◆ SetThresholdValues()

virtual void mitk::BinaryThresholdBaseTool::SetThresholdValues	(	double	lower,
		double	upper
	)

virtual

Member Data Documentation

◆ IntervalBordersChanged

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

Definition at line 38 of file mitkBinaryThresholdBaseTool.h.

◆ ThresholdingValuesChanged

Message2<ScalarType, ScalarType> mitk::BinaryThresholdBaseTool::ThresholdingValuesChanged

Definition at line 39 of file mitkBinaryThresholdBaseTool.h.

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

mitkBinaryThresholdBaseTool.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BinaryThresholdBaseTool()

◆ ~BinaryThresholdBaseTool()

Member Function Documentation

◆ DoUpdatePreview()

◆ GetLockedUpperThreshold()

◆ GetSensibleMaximumThreshold()

◆ GetSensibleMinimumThreshold()

◆ InitiateToolByInput()

◆ ITKThresholding()

◆ LockedUpperThresholdOff()

◆ LockedUpperThresholdOn()

◆ mitkClassMacro()

◆ SetLockedUpperThreshold()

◆ SetThresholdValues()

Member Data Documentation

◆ IntervalBordersChanged

◆ ThresholdingValuesChanged