CustusX  15.8
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cx::IgstkTool::InternalStructure Struct Reference

A tools internal structure. More...

#include <cxIgstkTool.h>

Public Member Functions

Transform3D getCalibrationAsSSC () const
 
void setCalibration (const Transform3D &cal)
 
void saveCalibrationToFile ()
 
bool verify ()
 
 InternalStructure ()
 sets up default values for all the members More...
 

Public Attributes

bool mIsReference
 
bool mIsPointer
 
bool mIsProbe
 
QString mName
 the tools name More...
 
QString mUid
 the tools unique id More...
 
std::vector< QString > mClinicalApplications
 the tools clinical application applications More...
 
TRACKING_SYSTEM mTrackerType
 what product the tool belongs to More...
 
QString mSROMFilename
 path to the tools SROM file More...
 
unsigned int mPortNumber
 the port number the tool is connected to More...
 
unsigned int mChannelNumber
 the channel the tool is connected to More...
 
std::map< int, Vector3DmReferencePoints
 optional point on the frame, specifying a known reference point, 0,0,0 is default, in sensor space More...
 
bool mWireless
 whether or not the tool is wireless More...
 
bool m5DOF
 whether or not the tool have 5 DOF More...
 
igstk::Transform mCalibration
 transform read from mCalibrationFilename More...
 
QString mCalibrationFilename
 path to the tools calibration file More...
 
QString mGraphicsFileName
 path to this tools graphics file More...
 
QString mPictureFileName
 path to picture of the tool More...
 
QString mTransformSaveFileName
 path to where transforms should be saved More...
 
QString mLoggingFolderName
 path to where log should be saved More...
 
QString mInstrumentId
 The instruments id. More...
 
QString mInstrumentScannerId
 The id of the ultrasound scanner if the instrument is a probe. More...
 

Detailed Description

A tools internal structure.

Warning
make sure you set all the members to an appropriate value.

Definition at line 80 of file cxIgstkTool.h.

Constructor & Destructor Documentation

cx::IgstkTool::InternalStructure::InternalStructure ( )
inline

sets up default values for all the members

Definition at line 109 of file cxIgstkTool.h.

Member Function Documentation

Transform3D cx::IgstkTool::InternalStructure::getCalibrationAsSSC ( ) const

Definition at line 47 of file cxIgstkTool.cpp.

void cx::IgstkTool::InternalStructure::saveCalibrationToFile ( )

Definition at line 60 of file cxIgstkTool.cpp.

void cx::IgstkTool::InternalStructure::setCalibration ( const Transform3D cal)

Definition at line 55 of file cxIgstkTool.cpp.

bool cx::IgstkTool::InternalStructure::verify ( )

Definition at line 102 of file cxIgstkTool.cpp.

Member Data Documentation

bool cx::IgstkTool::InternalStructure::m5DOF

whether or not the tool have 5 DOF

Definition at line 100 of file cxIgstkTool.h.

igstk::Transform cx::IgstkTool::InternalStructure::mCalibration

transform read from mCalibrationFilename

Definition at line 101 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mCalibrationFilename

path to the tools calibration file

Definition at line 102 of file cxIgstkTool.h.

unsigned int cx::IgstkTool::InternalStructure::mChannelNumber

the channel the tool is connected to

Definition at line 97 of file cxIgstkTool.h.

std::vector<QString> cx::IgstkTool::InternalStructure::mClinicalApplications

the tools clinical application applications

Definition at line 93 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mGraphicsFileName

path to this tools graphics file

Definition at line 103 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mInstrumentId

The instruments id.

Definition at line 107 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mInstrumentScannerId

The id of the ultrasound scanner if the instrument is a probe.

Definition at line 108 of file cxIgstkTool.h.

bool cx::IgstkTool::InternalStructure::mIsPointer

Definition at line 88 of file cxIgstkTool.h.

bool cx::IgstkTool::InternalStructure::mIsProbe

Definition at line 89 of file cxIgstkTool.h.

bool cx::IgstkTool::InternalStructure::mIsReference

Definition at line 87 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mLoggingFolderName

path to where log should be saved

Definition at line 106 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mName

the tools name

Definition at line 91 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mPictureFileName

path to picture of the tool

Definition at line 104 of file cxIgstkTool.h.

unsigned int cx::IgstkTool::InternalStructure::mPortNumber

the port number the tool is connected to

Definition at line 96 of file cxIgstkTool.h.

std::map<int, Vector3D> cx::IgstkTool::InternalStructure::mReferencePoints

optional point on the frame, specifying a known reference point, 0,0,0 is default, in sensor space

Definition at line 98 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mSROMFilename

path to the tools SROM file

Definition at line 95 of file cxIgstkTool.h.

TRACKING_SYSTEM cx::IgstkTool::InternalStructure::mTrackerType

what product the tool belongs to

Definition at line 94 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mTransformSaveFileName

path to where transforms should be saved

Definition at line 105 of file cxIgstkTool.h.

QString cx::IgstkTool::InternalStructure::mUid

the tools unique id

Definition at line 92 of file cxIgstkTool.h.

bool cx::IgstkTool::InternalStructure::mWireless

whether or not the tool is wireless

Definition at line 99 of file cxIgstkTool.h.


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