Interface for all Tracking Tools. More...

#include <mitkTrackingTool.h>

Inheritance diagram for mitk::TrackingTool:

Collaboration diagram for mitk::TrackingTool:

Public Member Functions
	mitkClassMacroItkParent (TrackingTool, itk::Object)

virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const override

virtual void	SetToolTip (Point3D toolTipPosition, Quaternion orientation, ScalarType eps=0.0)=0
	defines a tool tip for this tool in tool coordinates. GetPosition() and GetOrientation() return the data of the tool tip if it is defined. By default no tooltip is defined. More...

virtual void	GetPosition (Point3D &position) const =0
	returns the current position of the tool as an array of three floats (in the tracking device coordinate system) More...

virtual void	GetOrientation (Quaternion &orientation) const =0
	returns the current orientation of the tool as a quaternion in a mitk::Point4D (in the tracking device coordinate system) More...

virtual bool	Enable ()=0
	enables the tool, so that it will be tracked More...

virtual bool	Disable ()=0
	disables the tool, so that it will not be tracked anymore More...

virtual bool	IsEnabled () const =0
	returns whether the tool is enabled or disabled More...

virtual bool	IsDataValid () const =0
	returns true if the current position data is valid (no error during tracking, tracking error below threshold, ...) More...

virtual float	GetTrackingError () const =0
	returns one value that corresponds to the overall tracking error. More...

virtual const char *	GetToolName () const
	every tool has a name that can be used to identify it. More...

virtual const char *	GetErrorMessage () const
	if the data is not valid, ErrorMessage should contain a string explaining why it is invalid (the Set-method should be implemented in subclasses, it should not be accessible by the user) More...

virtual void	SetIGTTimeStamp (double _arg)

virtual double	GetIGTTimeStamp () const
	Sets the IGT timestamp of the tracking tool object (time in milliseconds) More...

Protected Member Functions
	TrackingTool ()
	Gets the IGT timestamp of the tracking tool object (time in milliseconds). Returns 0 if the timestamp was not set. More...

virtual	~TrackingTool ()

Protected Attributes
std::string	m_ToolName
	every tool has a name that can be used to identify it. More...

std::string	m_ErrorMessage
	if a tool is invalid, this member should contain a human readable explanation of why it is invalid More...

double	m_IGTTimeStamp
	contains the time at which the tracking data was recorded More...

itk::FastMutexLock::Pointer	m_MyMutex
	mutex to control concurrent access to the tool More...

Detailed Description

Interface for all Tracking Tools.

Documentation Abstract class that defines the methods that are common for all tracking tools.

Definition at line 36 of file mitkTrackingTool.h.

Constructor & Destructor Documentation

mitk::TrackingTool::TrackingTool ( )

protected

Gets the IGT timestamp of the tracking tool object (time in milliseconds). Returns 0 if the timestamp was not set.

Definition at line 23 of file mitkTrackingTool.cpp.

References m_MyMutex, and mitk::New().

mitk::TrackingTool::~TrackingTool ( )

protectedvirtual

Definition at line 30 of file mitkTrackingTool.cpp.

Member Function Documentation

virtual bool mitk::TrackingTool::Disable ( )

pure virtual

disables the tool, so that it will not be tracked anymore

Implemented in mitk::OptitrackTrackingTool, and mitk::InternalTrackingTool.

virtual bool mitk::TrackingTool::Enable ( )

pure virtual

enables the tool, so that it will be tracked

Implemented in mitk::OptitrackTrackingTool, and mitk::InternalTrackingTool.

const char * mitk::TrackingTool::GetErrorMessage ( ) const

virtual

if the data is not valid, ErrorMessage should contain a string explaining why it is invalid (the Set-method should be implemented in subclasses, it should not be accessible by the user)

Definition at line 50 of file mitkTrackingTool.cpp.

virtual double mitk::TrackingTool::GetIGTTimeStamp ( ) const

virtual

Sets the IGT timestamp of the tracking tool object (time in milliseconds)

Referenced by mitk::TrackingDeviceSource::GenerateData().

virtual void mitk::TrackingTool::GetOrientation ( Quaternion & orientation ) const

pure virtual

returns the current orientation of the tool as a quaternion in a mitk::Point4D (in the tracking device coordinate system)

Implemented in mitk::OptitrackTrackingTool, and mitk::InternalTrackingTool.

Referenced by mitk::TrackingDeviceSource::GenerateData().

virtual void mitk::TrackingTool::GetPosition ( Point3D & position ) const

pure virtual

returns the current position of the tool as an array of three floats (in the tracking device coordinate system)

Implemented in mitk::OptitrackTrackingTool, and mitk::InternalTrackingTool.

Referenced by mitk::TrackingDeviceSource::GenerateData().

const char * mitk::TrackingTool::GetToolName ( ) const

virtual

every tool has a name that can be used to identify it.

Definition at line 43 of file mitkTrackingTool.cpp.

Referenced by QmitkNDIConfigurationWidget::GenerateNavigationTool(), QmitkNDIConfigurationWidget::GetToolNamesList(), mitk::NDITrackingDevice::InitializeWiredTools(), and QmitkNDIConfigurationWidget::UpdateToolTable().

virtual float mitk::TrackingTool::GetTrackingError ( ) const

pure virtual

returns one value that corresponds to the overall tracking error.

Implemented in mitk::OptitrackTrackingTool, and mitk::InternalTrackingTool.

Referenced by mitk::TrackingDeviceSource::GenerateData().

virtual bool mitk::TrackingTool::IsDataValid ( ) const

pure virtual

returns true if the current position data is valid (no error during tracking, tracking error below threshold, ...)

Implemented in mitk::OptitrackTrackingTool, and mitk::InternalTrackingTool.

Referenced by mitk::TrackingDeviceSource::GenerateData().

virtual bool mitk::TrackingTool::IsEnabled ( ) const

pure virtual

returns whether the tool is enabled or disabled

Implemented in mitk::OptitrackTrackingTool, and mitk::InternalTrackingTool.

Referenced by mitk::TrackingDeviceSource::GenerateData(), and QmitkNDIConfigurationWidget::UpdateToolTable().

mitk::TrackingTool::mitkClassMacroItkParent	(	TrackingTool	,
		itk::Object
	)

void mitk::TrackingTool::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

overridevirtual

Reimplemented in mitk::InternalTrackingTool.

Definition at line 36 of file mitkTrackingTool.cpp.

virtual void mitk::TrackingTool::SetIGTTimeStamp ( double _arg )

virtual

virtual void mitk::TrackingTool::SetToolTip	(	Point3D	toolTipPosition,
		Quaternion	orientation,
		ScalarType	eps = `0.0`
	)

pure virtual

defines a tool tip for this tool in tool coordinates. GetPosition() and GetOrientation() return the data of the tool tip if it is defined. By default no tooltip is defined.

Implemented in mitk::InternalTrackingTool.

Member Data Documentation

std::string mitk::TrackingTool::m_ErrorMessage

protected

if a tool is invalid, this member should contain a human readable explanation of why it is invalid

Definition at line 60 of file mitkTrackingTool.h.

double mitk::TrackingTool::m_IGTTimeStamp

protected

contains the time at which the tracking data was recorded

Definition at line 61 of file mitkTrackingTool.h.

itk::FastMutexLock::Pointer mitk::TrackingTool::m_MyMutex

protected

mutex to control concurrent access to the tool

Definition at line 62 of file mitkTrackingTool.h.

Referenced by TrackingTool().

std::string mitk::TrackingTool::m_ToolName

protected

every tool has a name that can be used to identify it.

Definition at line 59 of file mitkTrackingTool.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation