Class representing the tools a navigation system can recognize. More...

#include <cxToolUsingIGSTK.h>

Inheritance diagram for cx::ToolUsingIGSTK:

Signals
void	attachedToTracker (bool)

Signals inherited from cx::Tool
void	toolTransformAndTimestamp (Transform3D matrix, double timestamp)

void	toolVisible (bool visible)

void	tooltipOffset (double offset)

void	toolProbeSector ()

void	tps (int)

Public Member Functions
	ToolUsingIGSTK (IgstkToolPtr igstkTool)

virtual	~ToolUsingIGSTK ()

virtual bool	getVisible () const

virtual bool	isInitialized () const

virtual QString	getUid () const

virtual QString	getName () const

virtual int	getIndex () const

virtual ProbePtr	getProbe () const
	additional information if the tool represents an US Probe. Extends getProbeSector() More...

virtual double	getTimestamp () const
	latest valid timestamp for the position matrix. 0 means indeterminate (for f.ex. manual tools) More...

virtual double	getTooltipOffset () const
	get a virtual offset extending from the tool tip. More...

virtual void	setTooltipOffset (double val)
	set a virtual offset extending from the tool tip. More...

virtual bool	isCalibrated () const
	true if calibration is different from identity More...

virtual Transform3D	getCalibration_sMt () const
	get the calibration transform from tool space to sensor space (where the spheres or similar live) More...

virtual void	setCalibration_sMt (Transform3D calibration)
	requests to use the calibration and replaces the tools calibration file More...

QString	getCalibrationFileName () const
	returns the path to the tools calibration file More...

TRACKING_SYSTEM	getTrackerType ()
	the type of tracker this tool belongs to More...

bool	isValid () const
	whether this tool is constructed correctly or not More...

virtual void	set_prMt (const Transform3D &prMt, double timestamp)
	if available for this type, set pos, ts<0 means use current time More...

virtual void	setVisible (bool vis)
	if available for this type, set visibility More...

virtual void	addXml (QDomNode &dataNode)

virtual void	parseXml (QDomNode &dataNode)

Public Member Functions inherited from cx::ToolImpl
	ToolImpl (const QString &uid="", const QString &name="")

virtual	~ToolImpl ()

virtual TimedTransformMapPtr	getPositionHistory ()
	get historical positions More...

virtual TimedTransformMap	getSessionHistory (double startTime, double stopTime)

virtual Transform3D	get_prMt () const

virtual ToolPtr	getBaseTool ()

virtual ToolPositionMetadata	getMetadata () const

virtual const std::map< double, ToolPositionMetadata > &	getMetadataHistory ()

virtual void	resetTrackingPositionFilter (TrackingPositionFilterPtr filter)

virtual bool	isNull ()

virtual vtkPolyDataPtr	getGraphicsPolyData () const
	get geometric 3D description More...

virtual bool	hasReferencePointWithId (QString id)

Public Member Functions inherited from cx::Tool
	Tool (const QString &uid="", const QString &name="")

virtual	~Tool ()

virtual bool	hasType (Type type) const

virtual void	printSelf (std::ostream &os, Indent indent)
	dump internal debug data More...

Protected Member Functions
virtual ToolFileParser::ToolInternalStructurePtr	getToolFileToolStructure () const

Protected Member Functions inherited from cx::ToolImpl
void	createToolGraphic ()

virtual std::set< Type >	getTypes () const

virtual std::map< QString, Vector3D >	getReferencePoints () const
	Get the optional reference points from this tool. More...

Additional Inherited Members
Public Types inherited from cx::Tool
enum	State { tsNONE =0, tsCONFIGURED, tsINITIALIZED, tsTRACKING }

enum	Type { TOOL_NONE, TOOL_REFERENCE, TOOL_MANUAL, TOOL_POINTER, TOOL_US_PROBE, TOOL_MICROSCOPE }

Static Public Member Functions inherited from cx::Tool
static vtkPolyDataPtr	createDefaultPolyDataCone ()

static ToolPtr	getNullObject ()

Protected Attributes inherited from cx::ToolImpl
TimedTransformMapPtr	mPositionHistory

Transform3D	m_prMt
	the transform from the tool to the patient reference More...

TrackingPositionFilterPtr	mTrackingPositionFilter

std::map< double, ToolPositionMetadata >	mMetadata

vtkPolyDataPtr	mPolyData
	the polydata used to represent the tool graphically More...

Protected Attributes inherited from cx::Tool
QString	mUid

QString	mName

Detailed Description

Class representing the tools a navigation system can recognize.

Date: Nov 6, 2008

Author: Janne Beate Bakeng, SINTEF

Definition at line 56 of file cxToolUsingIGSTK.h.

Constructor & Destructor Documentation

cx::ToolUsingIGSTK::ToolUsingIGSTK ( IgstkToolPtr igstkTool )

Definition at line 28 of file cxToolUsingIGSTK.cpp.

cx::ToolUsingIGSTK::~ToolUsingIGSTK ( )

virtual

Definition at line 55 of file cxToolUsingIGSTK.cpp.

Member Function Documentation

void cx::ToolUsingIGSTK::addXml ( QDomNode & dataNode )

virtual

Reimplemented from cx::ToolImpl.

Definition at line 142 of file cxToolUsingIGSTK.cpp.

void cx::ToolUsingIGSTK::attachedToTracker ( bool )

signal

Transform3D cx::ToolUsingIGSTK::getCalibration_sMt ( ) const

virtual

get the calibration transform from tool space to sensor space (where the spheres or similar live)

Implements cx::Tool.

Definition at line 110 of file cxToolUsingIGSTK.cpp.

QString cx::ToolUsingIGSTK::getCalibrationFileName ( ) const

returns the path to the tools calibration file

Definition at line 122 of file cxToolUsingIGSTK.cpp.

virtual int cx::ToolUsingIGSTK::getIndex ( ) const

inlinevirtual

Definition at line 82 of file cxToolUsingIGSTK.h.

QString cx::ToolUsingIGSTK::getName ( ) const

virtual

Returns: a descriptive name for this instance

Implements cx::Tool.

Definition at line 79 of file cxToolUsingIGSTK.cpp.

ProbePtr cx::ToolUsingIGSTK::getProbe ( ) const

virtual

additional information if the tool represents an US Probe. Extends getProbeSector()

Reimplemented from cx::Tool.

Definition at line 59 of file cxToolUsingIGSTK.cpp.

virtual double cx::ToolUsingIGSTK::getTimestamp ( ) const

inlinevirtual

latest valid timestamp for the position matrix. 0 means indeterminate (for f.ex. manual tools)

Implements cx::Tool.

Definition at line 84 of file cxToolUsingIGSTK.h.

ToolFileParser::ToolInternalStructurePtr cx::ToolUsingIGSTK::getToolFileToolStructure ( ) const

protectedvirtual

Reimplemented from cx::ToolImpl.

Definition at line 137 of file cxToolUsingIGSTK.cpp.

double cx::ToolUsingIGSTK::getTooltipOffset ( ) const

virtual

get a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 84 of file cxToolUsingIGSTK.cpp.

TRACKING_SYSTEM cx::ToolUsingIGSTK::getTrackerType ( )

the type of tracker this tool belongs to

Definition at line 127 of file cxToolUsingIGSTK.cpp.

QString cx::ToolUsingIGSTK::getUid ( ) const

virtual

Returns: an unique id for this instance

Implements cx::Tool.

Definition at line 74 of file cxToolUsingIGSTK.cpp.

bool cx::ToolUsingIGSTK::getVisible ( ) const

virtual

Returns: the visibility status of the tool

Implements cx::Tool.

Definition at line 64 of file cxToolUsingIGSTK.cpp.

bool cx::ToolUsingIGSTK::isCalibrated ( ) const

virtual

true if calibration is different from identity

Implements cx::Tool.

Definition at line 103 of file cxToolUsingIGSTK.cpp.

bool cx::ToolUsingIGSTK::isInitialized ( ) const

virtual

Reimplemented from cx::Tool.

Definition at line 69 of file cxToolUsingIGSTK.cpp.

bool cx::ToolUsingIGSTK::isValid ( ) const

whether this tool is constructed correctly or not

Definition at line 98 of file cxToolUsingIGSTK.cpp.

void cx::ToolUsingIGSTK::parseXml ( QDomNode & dataNode )

virtual

Reimplemented from cx::ToolImpl.

Definition at line 154 of file cxToolUsingIGSTK.cpp.

void cx::ToolUsingIGSTK::set_prMt	(	const Transform3D &	prMt,
		double	timestamp
	)

virtual

if available for this type, set pos, ts<0 means use current time

Reimplemented from cx::ToolImpl.

Definition at line 219 of file cxToolUsingIGSTK.cpp.

void cx::ToolUsingIGSTK::setCalibration_sMt ( Transform3D calibration )

virtual

requests to use the calibration and replaces the tools calibration file

Reimplemented from cx::Tool.

Definition at line 117 of file cxToolUsingIGSTK.cpp.

void cx::ToolUsingIGSTK::setTooltipOffset ( double val )

virtual

set a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 91 of file cxToolUsingIGSTK.cpp.

void cx::ToolUsingIGSTK::setVisible ( bool vis )

virtual

if available for this type, set visibility

Implements cx::Tool.

Definition at line 225 of file cxToolUsingIGSTK.cpp.

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

/media/jenkins/bamboo/buildagent/xml-data/build-dir/CX-NI-JOB1/CX/CX/source/plugins/org.custusx.core.tracking.system.igstk/trackingSystemIGSTK/cxToolUsingIGSTK.h
/media/jenkins/bamboo/buildagent/xml-data/build-dir/CX-NI-JOB1/CX/CX/source/plugins/org.custusx.core.tracking.system.igstk/trackingSystemIGSTK/cxToolUsingIGSTK.cpp

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation