CustusX  2021.04.22-dev+develop.337f9
An IGT application
cx::BronchoscopyTool Class Reference

A tool used during playback. More...

#include <cxBronchoscopyTool.h>

Inheritance diagram for cx::BronchoscopyTool:
cx::ToolImpl cx::Tool

Public Member Functions

 BronchoscopyTool (ToolPtr base, BronchoscopePositionProjectionPtr projectionCenterline)
 
virtual ~BronchoscopyTool ()
 
virtual std::set< TypegetTypes () const
 
virtual vtkPolyDataPtr getGraphicsPolyData () const
 get geometric 3D description More...
 
virtual Transform3D get_prMt () const
 
virtual bool getVisible () const
 
virtual QString getUid () const
 
virtual QString getName () const
 
virtual bool isCalibrated () const
 a tool may not be calibrated, then no tracking is allowed 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 Transform3D getCalibration_sMt () const
 get the calibration transform from tool space to sensor space (where the spheres or similar live) More...
 
virtual std::map< int, Vector3DgetReferencePoints () const
 Get the optional reference points from this tool. More...
 
virtual TimedTransformMapPtr getPositionHistory ()
 get historical positions More...
 
virtual bool isInitialized () const
 
virtual ProbePtr getProbe () const
 additional information if the tool represents an US Probe. Extends getProbeSector() More...
 
virtual bool hasReferencePointWithId (int id)
 
virtual TimedTransformMap getSessionHistory (double startTime, double stopTime)
 
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...
 
ToolPtr getBase ()
 
- Public Member Functions inherited from cx::ToolImpl
 ToolImpl (const QString &uid="", const QString &name="")
 
virtual ~ToolImpl ()
 
virtual ToolPositionMetadata getMetadata () const
 
virtual const std::map< double, ToolPositionMetadata > & getMetadataHistory ()
 
virtual void resetTrackingPositionFilter (TrackingPositionFilterPtr filter)
 
virtual bool isNull ()
 
virtual void addXml (QDomNode &dataNode)
 
virtual void parseXml (QDomNode &dataNode)
 
- Public Member Functions inherited from cx::Tool
 Tool (const QString &uid="", const QString &name="")
 
virtual ~Tool ()
 
virtual bool hasType (Type type) const
 
virtual void setCalibration_sMt (Transform3D calibration)
 requests to use the calibration and replaces the tools calibration file More...
 
virtual void printSelf (std::ostream &os, Indent indent)
 dump internal debug data 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
}
 
- Signals inherited from cx::Tool
void toolTransformAndTimestamp (Transform3D matrix, double timestamp)
 
void toolVisible (bool visible)
 
void tooltipOffset (double offset)
 
void toolProbeSector ()
 
void tps (int)
 
- Static Public Member Functions inherited from cx::Tool
static vtkPolyDataPtr createDefaultPolyDataCone ()
 
static ToolPtr getNullObject ()
 
- Protected Member Functions inherited from cx::ToolImpl
void createToolGraphic ()
 
virtual ToolFileParser::ToolInternalStructurePtr getToolFileToolStructure () const
 
- 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, ToolPositionMetadatamMetadata
 
vtkPolyDataPtr mPolyData
 the polydata used to represent the tool graphically More...
 
- Protected Attributes inherited from cx::Tool
QString mUid
 
QString mName
 

Detailed Description

A tool used during playback.

Date
2014-11-11
Author
Erlend Hofstad & Christian Askeland, SINTEF

Definition at line 54 of file cxBronchoscopyTool.h.

Constructor & Destructor Documentation

cx::BronchoscopyTool::BronchoscopyTool ( ToolPtr  base,
BronchoscopePositionProjectionPtr  projectionCenterline 
)
explicit

Definition at line 42 of file cxBronchoscopyTool.cpp.

cx::BronchoscopyTool::~BronchoscopyTool ( )
virtual

Definition at line 55 of file cxBronchoscopyTool.cpp.

Member Function Documentation

Transform3D cx::BronchoscopyTool::get_prMt ( ) const
virtual

Reimplemented from cx::ToolImpl.

Definition at line 83 of file cxBronchoscopyTool.cpp.

ToolPtr cx::BronchoscopyTool::getBase ( )
inline

Definition at line 86 of file cxBronchoscopyTool.h.

Transform3D cx::BronchoscopyTool::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 125 of file cxBronchoscopyTool.cpp.

vtkPolyDataPtr cx::BronchoscopyTool::getGraphicsPolyData ( ) const
virtual

get geometric 3D description

Reimplemented from cx::ToolImpl.

Definition at line 78 of file cxBronchoscopyTool.cpp.

QString cx::BronchoscopyTool::getName ( ) const
virtual
Returns
a descriptive name for this instance

Implements cx::Tool.

Definition at line 98 of file cxBronchoscopyTool.cpp.

virtual TimedTransformMapPtr cx::BronchoscopyTool::getPositionHistory ( )
inlinevirtual

get historical positions

Reimplemented from cx::ToolImpl.

Definition at line 76 of file cxBronchoscopyTool.h.

virtual ProbePtr cx::BronchoscopyTool::getProbe ( ) const
inlinevirtual

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

Reimplemented from cx::Tool.

Definition at line 78 of file cxBronchoscopyTool.h.

std::map< int, Vector3D > cx::BronchoscopyTool::getReferencePoints ( ) const
virtual

Get the optional reference points from this tool.

Reimplemented from cx::ToolImpl.

Definition at line 130 of file cxBronchoscopyTool.cpp.

virtual TimedTransformMap cx::BronchoscopyTool::getSessionHistory ( double  startTime,
double  stopTime 
)
inlinevirtual

Reimplemented from cx::ToolImpl.

Definition at line 80 of file cxBronchoscopyTool.h.

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

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

Implements cx::Tool.

Definition at line 108 of file cxBronchoscopyTool.cpp.

double cx::BronchoscopyTool::getTooltipOffset ( ) const
virtual

get a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 114 of file cxBronchoscopyTool.cpp.

std::set< Tool::Type > cx::BronchoscopyTool::getTypes ( ) const
virtual

Reimplemented from cx::ToolImpl.

Definition at line 60 of file cxBronchoscopyTool.cpp.

QString cx::BronchoscopyTool::getUid ( ) const
virtual
Returns
an unique id for this instance

Implements cx::Tool.

Definition at line 93 of file cxBronchoscopyTool.cpp.

bool cx::BronchoscopyTool::getVisible ( ) const
virtual
Returns
the visibility status of the tool

Implements cx::Tool.

Definition at line 88 of file cxBronchoscopyTool.cpp.

virtual bool cx::BronchoscopyTool::hasReferencePointWithId ( int  id)
inlinevirtual

Reimplemented from cx::ToolImpl.

Definition at line 79 of file cxBronchoscopyTool.h.

bool cx::BronchoscopyTool::isCalibrated ( ) const
virtual

a tool may not be calibrated, then no tracking is allowed

Implements cx::Tool.

Definition at line 103 of file cxBronchoscopyTool.cpp.

bool cx::BronchoscopyTool::isInitialized ( ) const
virtual

Reimplemented from cx::Tool.

Definition at line 135 of file cxBronchoscopyTool.cpp.

void cx::BronchoscopyTool::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 140 of file cxBronchoscopyTool.cpp.

void cx::BronchoscopyTool::setTooltipOffset ( double  val)
virtual

set a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 120 of file cxBronchoscopyTool.cpp.

void cx::BronchoscopyTool::setVisible ( bool  vis)
virtual

if available for this type, set visibility

Implements cx::Tool.

Definition at line 146 of file cxBronchoscopyTool.cpp.


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