An object of this class represents a MicronTracker 2 tool. A tool has to be added to a tracking device which will then continuously update the tool coordinates. More...

#include <mitkClaronTool.h>

Inheritance diagram for mitk::ClaronTool:

[legend]

Collaboration diagram for mitk::ClaronTool:

[legend]

Public Member Functions
	mitkClassMacro (ClaronTool, InternalTrackingTool)

bool	LoadFile (const char *filename)
	Loads a tool calibration file. Without this file the tool can not be tracked! More...

bool	LoadFile (std::string filename)
	Loads a tool calibration file. Without this file the tool can not be tracked! More...

std::string	GetFile ()

void	SetToolHandle (claronToolHandle handle)
	Sets the handle of the tool. More...

std::string	GetCalibrationName ()

void	SetCalibrationName (std::string name)
	Sets the calibration name of the tool. Be careful, only use this method if you know what you are doing. If you want to change the tool name use the method setToolName instead! More...

claronToolHandle	GetToolHandle ()

Public Member Functions inherited from mitk::InternalTrackingTool
	mitkClassMacro (InternalTrackingTool, TrackingTool)

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

virtual void	GetPosition (Point3D &position) const override
	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 override
	returns the current orientation of the tool as a quaternion (in the tracking device coordinate system) More...

virtual bool	Enable () override
	enablea the tool, so that it will be tracked. Returns true if enabling was successfull More...

virtual bool	Disable () override
	disables the tool, so that it will not be tracked anymore. Returns true if disabling was successfull More...

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

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

virtual float	GetTrackingError () const override
	return one value that corresponds to the overall tracking error. The dimension of this value is specific to each tracking device More...

virtual bool	IsTooltipSet () const
	returns true if a tooltip is set, false if not More...

virtual void	SetToolName (const std::string _arg)
	Sets the name of the tool. More...

virtual void	SetToolName (const char *_arg)
	Sets the name of the tool. More...

virtual void	SetPosition (Point3D position)
	sets the position More...

virtual void	SetOrientation (Quaternion orientation)
	sets the orientation as a quaternion More...

virtual void	SetTrackingError (float error)
	sets the tracking error More...

virtual void	SetDataValid (bool _arg)
	sets if the tracking data (position & Orientation) is valid More...

virtual void	SetErrorMessage (const char *_arg)
	sets the error message More...

virtual void	SetToolTip (Point3D toolTipPosition, Quaternion orientation=Quaternion(0, 0, 0, 1), ScalarType eps=0.0) override
	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...

Public Member Functions inherited from mitk::TrackingTool
	mitkClassMacroItkParent (TrackingTool, itk::Object)

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
Pointer	Clone () const

	ClaronTool ()

virtual	~ClaronTool ()

Protected Member Functions inherited from mitk::InternalTrackingTool
Pointer	Clone () const

	InternalTrackingTool ()

virtual	~InternalTrackingTool ()

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

virtual	~TrackingTool ()

Static Protected Member Functions
static Pointer	New ()

Static Protected Member Functions inherited from mitk::InternalTrackingTool
static Pointer	New ()

Protected Attributes
claronToolHandle	m_ToolHandle
	Tool handle variable from tracking device. More...

std::string	m_CalibrationName
	Variable which holds the Tool's calibration name. More...

std::string	m_Filename
	Variable to check filename's format and to get back complete filename. More...

Protected Attributes inherited from mitk::InternalTrackingTool
Point3D	m_Position
	holds the position of the tool More...

Quaternion	m_Orientation
	holds the orientation of the tool More...

float	m_TrackingError
	holds the tracking error of the tool More...

bool	m_Enabled
	if true, tool is enabled and should receive tracking updates from the tracking device More...

bool	m_DataValid
	if true, data in m_Position and m_Orientation is valid, e.g. true tracking data More...

Point3D	m_ToolTip

Quaternion	m_ToolTipRotation

bool	m_ToolTipSet

Protected Attributes inherited from mitk::TrackingTool
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

An object of this class represents a MicronTracker 2 tool. A tool has to be added to a tracking device which will then continuously update the tool coordinates.

Documentation:

Definition at line 33 of file mitkClaronTool.h.

Constructor & Destructor Documentation

mitk::ClaronTool::ClaronTool ( )

protected

Definition at line 22 of file mitkClaronTool.cpp.

mitk::ClaronTool::~ClaronTool ( void )

protectedvirtual

Definition at line 26 of file mitkClaronTool.cpp.

Member Function Documentation

Pointer mitk::ClaronTool::Clone ( ) const

protected

std::string mitk::ClaronTool::GetCalibrationName ( )

Returns: Returns the calibration name which is used to identify the tool.

Definition at line 30 of file mitkClaronTool.cpp.

std::string mitk::ClaronTool::GetFile ( )

Definition at line 91 of file mitkClaronTool.cpp.

mitk::claronToolHandle mitk::ClaronTool::GetToolHandle ( )

Returns: Returns the tool handle of the tool.

Definition at line 101 of file mitkClaronTool.cpp.

bool mitk::ClaronTool::LoadFile ( const char * filename )

Loads a tool calibration file. Without this file the tool can not be tracked!

Definition at line 40 of file mitkClaronTool.cpp.

bool mitk::ClaronTool::LoadFile ( std::string filename )

Loads a tool calibration file. Without this file the tool can not be tracked!

Definition at line 52 of file mitkClaronTool.cpp.

References filename.

mitk::ClaronTool::mitkClassMacro	(	ClaronTool	,
		InternalTrackingTool
	)

static Pointer mitk::ClaronTool::New ( )

staticprotected

Referenced by mitk::ClaronTrackingDevice::AddTool(), and mitk::ClaronTrackingDevice::DetectTools().

void mitk::ClaronTool::SetCalibrationName ( std::string name )

Sets the calibration name of the tool. Be careful, only use this method if you know what you are doing. If you want to change the tool name use the method setToolName instead!

Definition at line 35 of file mitkClaronTool.cpp.

void mitk::ClaronTool::SetToolHandle ( mitk::claronToolHandle handle )

Sets the handle of the tool.

Parameters

handle The new handle of the tool.

Definition at line 96 of file mitkClaronTool.cpp.

Member Data Documentation

std::string mitk::ClaronTool::m_CalibrationName

protected

Variable which holds the Tool's calibration name.

Definition at line 81 of file mitkClaronTool.h.

std::string mitk::ClaronTool::m_Filename

protected

Variable to check filename's format and to get back complete filename.

Definition at line 83 of file mitkClaronTool.h.

claronToolHandle mitk::ClaronTool::m_ToolHandle

protected

Tool handle variable from tracking device.

Definition at line 79 of file mitkClaronTool.h.

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation