Navigation step for marking risk structures. The user can add risk structures by interacting with the render windows. The risk structures are organized in an embedded table view. More...

#include <QmitkUSNavigationStepZoneMarking.h>

Inheritance diagram for QmitkUSNavigationStepZoneMarking:

Public Member Functions
	QmitkUSNavigationStepZoneMarking (QWidget *parent=nullptr)

	~QmitkUSNavigationStepZoneMarking () override

bool	OnStartStep () override
	Initialization of the data storage nodes.

bool	OnStopStep () override
	Resets widget and filter and removes nodes from the data storage.

bool	OnFinishStep () override
	There is nothing to be done.

bool	OnActivateStep () override
	Selects input for the node displacement filter and emits "ReadyForNextStep" signal. The input selection cannot be done earlier.

bool	OnDeactivateStep () override
	Called when the navigation step gets deactivated (-> state started). This method may be implemented by a concrete subclass to handle actions necessary on deactivating the navigation step, which means switching to another step.

void	OnUpdate () override
	Updates just the tracking validity status.

void	OnSettingsChanged (const itk::SmartPointer< mitk::DataNode > settingsNode) override

QString	GetTitle () override
	Getter for the title of the navigation step. This title should be human readable and can be used to display the available steps and the currently active step to the user. The method has to be implemented by a concrete subclass.

FilterVector	GetFilter () override

Public Member Functions inherited from QmitkUSAbstractNavigationStep
	QmitkUSAbstractNavigationStep (QWidget *parent=nullptr)

	~QmitkUSAbstractNavigationStep () override

virtual bool	GetIsRestartable ()
	Indicates if it makes sense to be able to restart the step. This method must be implemented by concrete subclasses if it should not be possible to restart them.

void	SetDataStorage (itk::SmartPointer< mitk::DataStorage > dataStorage)
	Sets the data storage for the exchange of results between navigation steps.

void	SetCombinedModality (itk::SmartPointer< mitk::AbstractUltrasoundTrackerDevice > combinedModality)
	Sets the combined modality for the navigation step. OnSetCombinedModality() is called internal.

bool	StartStep ()
	Should be called to start the navigation step.

bool	StopStep ()
	Should be called to stop the navigation step.

bool	RestartStep ()
	Should be called to restart the navigation step.

bool	FinishStep ()
	Should be called to finish the navigation step. The state has to be 'active' before and is 'started' afterwards.

bool	ActivateStep ()
	Should be called to activate the navigation step. The step gets started before if it was stopped.

bool	DeactivateStep ()
	Should be called to deactivate the navigation step.

void	Update ()
	Should be called periodically while the navigation step is active. Internal, the method OnUpdate() is called.

NavigationStepState	GetNavigationStepState ()
	Get the current state of the navigation step.

Protected Slots
void	OnFreeze (bool freezed)

void	OnZoneAdded ()
	Triggered when a risk zone was added. Adds the zone to a member variable and to the node displacement filter.

void	OnZoneRemoved ()
	Triggered when a risk zone was removed. Removes the zone from a member variable and from the node displacement filter.

void	OnShowListClicked (int state)

Protected Member Functions
void	OnSetCombinedModality () override
	Called every time SetCombinedModality() was called. This method may be implemented by a concrete subclass to handle this event. The default implementation does nothing.

void	UpdateReferenceSensorName ()

Protected Member Functions inherited from QmitkUSAbstractNavigationStep
virtual bool	OnRestartStep ()
	Called when restarting a navigation step. This method may be implemented by a concrete subclass to handle actions necessary for restarting the navigation step. The default implementations calls OnStopStep() followed by OnStartStep().

itk::SmartPointer< mitk::DataStorage >	GetDataStorage (bool throwNull=true)
	Returns the data storage set for the navigation step.

itk::SmartPointer< mitk::AbstractUltrasoundTrackerDevice >	GetCombinedModality (bool throwNull=true)
	Returns the combined modality set for the navigation step.

itk::SmartPointer< mitk::DataNode >	GetNamedDerivedNode (const char name, const char sourceName)
	Returns node with the given name and the given source node (parent) from the data storage.

itk::SmartPointer< mitk::DataNode >	GetNamedDerivedNodeAndCreate (const char name, const char sourceName)
	Returns node with the given name and the given source node (parent) from the data storage. The node is created if no matching node was found.

Protected Attributes
itk::SmartPointer< mitk::NavigationDataSource >	m_NavigationDataSource

itk::SmartPointer< mitk::NodeDisplacementFilter >	m_ZoneDisplacementFilter

std::vector< itk::SmartPointer< mitk::DataNode > >	m_ZoneNodes

std::string	m_StateMachineFilename

std::string	m_ReferenceSensorName

unsigned int	m_ReferenceSensorIndex

bool	m_CurrentlyAddingZone

Additional Inherited Members
Public Types inherited from QmitkUSAbstractNavigationStep
enum	NavigationStepState { State_Stopped , State_Started , State_Active }

typedef std::vector< itk::SmartPointer< mitk::NavigationDataToNavigationDataFilter > >	FilterVector

Signals inherited from QmitkUSAbstractNavigationStep
void	SignalReadyForNextStep ()
	Signals that all necessary actions where done. The user can proceed with the next stept after this was signaled.

void	SignalNoLongerReadyForNextStep ()
	Signals that it is no longer possible to proceed with following steps. This signal is emitted when the result data of the step was removed or changed, so that the old results are invalid for following steps.

void	SignalCombinedModalityChanged (itk::SmartPointer< mitk::AbstractUltrasoundTrackerDevice >)
	Signals that the combined modality was changed by this step. This signal is mainly for steps which creates the combined modality. The new combined modality is given as a parameter.

void	SignalIntermediateResult (const itk::SmartPointer< mitk::DataNode >)
	Signals that an intermediate result was produced. The properties of the given data node must contain the results. This signal can be used to log the intermediate results of an experiment, for example by using the mitk::USNavigationExperimentLogging.

void	SignalSettingsNodeChanged (itk::SmartPointer< mitk::DataNode >)
	Signals that the settings node was changed. This signal must not be emitted in an OnSettingsChanged() method.

Static Public Attributes inherited from QmitkUSAbstractNavigationStep
static const char *	DATANAME_SETTINGS = "Settings"

static const char *	DATANAME_IMAGESTREAM = "US Image Stream"

static const char *	DATANAME_BASENODE = QmitkUSAbstractNavigationStep::DATANAME_IMAGESTREAM

Detailed Description

Navigation step for marking risk structures. The user can add risk structures by interacting with the render windows. The risk structures are organized in an embedded table view.

The risk structures are stored under DATANAME_BASENODE -> DATANAME_ZONES.

This step is ready for the next step directly after activating. All actions to be done in this step are optional.

Definition at line 41 of file QmitkUSNavigationStepZoneMarking.h.

Constructor & Destructor Documentation

◆ QmitkUSNavigationStepZoneMarking()

QmitkUSNavigationStepZoneMarking::QmitkUSNavigationStepZoneMarking ( QWidget * parent = nullptr )

explicit

Definition at line 20 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ ~QmitkUSNavigationStepZoneMarking()

QmitkUSNavigationStepZoneMarking::~QmitkUSNavigationStepZoneMarking ( )

override

Definition at line 43 of file QmitkUSNavigationStepZoneMarking.cpp.

Member Function Documentation

◆ GetFilter()

QmitkUSAbstractNavigationStep::FilterVector QmitkUSNavigationStepZoneMarking::GetFilter ( )

overridevirtual

Returns: a node displacement filter for the zone surfaces

Reimplemented from QmitkUSAbstractNavigationStep.

Definition at line 150 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ GetTitle()

QString QmitkUSNavigationStepZoneMarking::GetTitle ( )

overridevirtual

Getter for the title of the navigation step. This title should be human readable and can be used to display the available steps and the currently active step to the user. The method has to be implemented by a concrete subclass.

Implements QmitkUSAbstractNavigationStep.

Definition at line 145 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnActivateStep()

bool QmitkUSNavigationStepZoneMarking::OnActivateStep ( )

overridevirtual

Selects input for the node displacement filter and emits "ReadyForNextStep" signal. The input selection cannot be done earlier.

Returns

Implements QmitkUSAbstractNavigationStep.

Definition at line 83 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnDeactivateStep()

bool QmitkUSNavigationStepZoneMarking::OnDeactivateStep ( )

overridevirtual

Called when the navigation step gets deactivated (-> state started). This method may be implemented by a concrete subclass to handle actions necessary on deactivating the navigation step, which means switching to another step.

Returns: if the actions were done successfully; true on every call for the default implementation

Reimplemented from QmitkUSAbstractNavigationStep.

Definition at line 93 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnFinishStep()

bool QmitkUSNavigationStepZoneMarking::OnFinishStep ( )

overridevirtual

There is nothing to be done.

Returns: always true

Implements QmitkUSAbstractNavigationStep.

Definition at line 78 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnFreeze

void QmitkUSNavigationStepZoneMarking::OnFreeze ( bool freezed )

protectedslot

Definition at line 155 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnSetCombinedModality()

void QmitkUSNavigationStepZoneMarking::OnSetCombinedModality ( )

overrideprotectedvirtual

Called every time SetCombinedModality() was called. This method may be implemented by a concrete subclass to handle this event. The default implementation does nothing.

Reimplemented from QmitkUSAbstractNavigationStep.

Definition at line 231 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnSettingsChanged()

void QmitkUSNavigationStepZoneMarking::OnSettingsChanged ( const itk::SmartPointer< mitk::DataNode > settingsNode )

overridevirtual

The property "settings.interaction-concept" is used.

Reimplemented from QmitkUSAbstractNavigationStep.

Definition at line 125 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnShowListClicked

void QmitkUSNavigationStepZoneMarking::OnShowListClicked ( int state )

protectedslot

Definition at line 37 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnStartStep()

bool QmitkUSNavigationStepZoneMarking::OnStartStep ( )

overridevirtual

Initialization of the data storage nodes.

Returns: always true

Implements QmitkUSAbstractNavigationStep.

Definition at line 48 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnStopStep()

bool QmitkUSNavigationStepZoneMarking::OnStopStep ( )

overridevirtual

Resets widget and filter and removes nodes from the data storage.

Returns: always true

Reimplemented from QmitkUSAbstractNavigationStep.

Definition at line 58 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnUpdate()

void QmitkUSNavigationStepZoneMarking::OnUpdate ( )

overridevirtual

Updates just the tracking validity status.

Implements QmitkUSAbstractNavigationStep.

Definition at line 100 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnZoneAdded

void QmitkUSNavigationStepZoneMarking::OnZoneAdded ( )

protectedslot

Triggered when a risk zone was added. Adds the zone to a member variable and to the node displacement filter.

Definition at line 177 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ OnZoneRemoved

void QmitkUSNavigationStepZoneMarking::OnZoneRemoved ( )

protectedslot

Triggered when a risk zone was removed. Removes the zone from a member variable and from the node displacement filter.

Definition at line 205 of file QmitkUSNavigationStepZoneMarking.cpp.

◆ UpdateReferenceSensorName()

void QmitkUSNavigationStepZoneMarking::UpdateReferenceSensorName ( )

protected

Definition at line 244 of file QmitkUSNavigationStepZoneMarking.cpp.

Member Data Documentation

◆ m_CurrentlyAddingZone

bool QmitkUSNavigationStepZoneMarking::m_CurrentlyAddingZone

protected

Definition at line 124 of file QmitkUSNavigationStepZoneMarking.h.

◆ m_NavigationDataSource

itk::SmartPointer<mitk::NavigationDataSource> QmitkUSNavigationStepZoneMarking::m_NavigationDataSource

protected

Definition at line 116 of file QmitkUSNavigationStepZoneMarking.h.

◆ m_ReferenceSensorIndex

unsigned int QmitkUSNavigationStepZoneMarking::m_ReferenceSensorIndex

protected

Definition at line 122 of file QmitkUSNavigationStepZoneMarking.h.

◆ m_ReferenceSensorName

std::string QmitkUSNavigationStepZoneMarking::m_ReferenceSensorName

protected

Definition at line 121 of file QmitkUSNavigationStepZoneMarking.h.

◆ m_StateMachineFilename

std::string QmitkUSNavigationStepZoneMarking::m_StateMachineFilename

protected

Definition at line 120 of file QmitkUSNavigationStepZoneMarking.h.

◆ m_ZoneDisplacementFilter

itk::SmartPointer<mitk::NodeDisplacementFilter> QmitkUSNavigationStepZoneMarking::m_ZoneDisplacementFilter

protected

Definition at line 117 of file QmitkUSNavigationStepZoneMarking.h.

◆ m_ZoneNodes

std::vector<itk::SmartPointer<mitk::DataNode> > QmitkUSNavigationStepZoneMarking::m_ZoneNodes

protected

Definition at line 118 of file QmitkUSNavigationStepZoneMarking.h.

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

Plugins/org.mitk.gui.qt.igt.app.ultrasoundtrackingnavigation/src/internal/NavigationStepWidgets/QmitkUSNavigationStepZoneMarking.h
Plugins/org.mitk.gui.qt.igt.app.ultrasoundtrackingnavigation/src/internal/NavigationStepWidgets/QmitkUSNavigationStepZoneMarking.cpp

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QmitkUSNavigationStepZoneMarking()

◆ ~QmitkUSNavigationStepZoneMarking()

Member Function Documentation

◆ GetFilter()

◆ GetTitle()

◆ OnActivateStep()

◆ OnDeactivateStep()

◆ OnFinishStep()

◆ OnFreeze

◆ OnSetCombinedModality()

◆ OnSettingsChanged()

◆ OnShowListClicked

◆ OnStartStep()

◆ OnStopStep()

◆ OnUpdate()

◆ OnZoneAdded

◆ OnZoneRemoved

◆ UpdateReferenceSensorName()

Member Data Documentation

◆ m_CurrentlyAddingZone

◆ m_NavigationDataSource

◆ m_ReferenceSensorIndex

◆ m_ReferenceSensorName

◆ m_StateMachineFilename

◆ m_ZoneDisplacementFilter

◆ m_ZoneNodes