File: qtrackingdata.md

package info (click to toggle)
openigtlink 3.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,080 kB
  • sloc: cpp: 20,076; ansic: 6,704; sh: 227; perl: 74; makefile: 46
file content (92 lines) | stat: -rw-r--r-- 2,791 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
[Back to Index](/Documents/Protocol/index.md)

QuaternionTrackingData Message
==============================

- Protocol Version: 3.0
- Release Date: January 20, 2017

Summary
===================

The QTDATA message type is intended for transferring 3D positions of surgical
tools, markers etc. Its role is almost identical to TDATA, except that QTDATA
describes orientation by using quaternion.

Message Types
===================

QTDATA
-------------------

 Data          | Type          | Description
---------------|---------------|-------------------------------------------------
 NAME_0        | char[20]      | Name (=Id) of the instrument/tracker # 0
 TYPE_0        | uint8         | Type of instrument for #0
 (--)          | uint8         | Researved
 POSITION_0    | float32[3]    | (X, Y, Z)
 QUATERNION_0  | float32[4]    |Quaternion (QX, QY, QZ, W)
 ...           | ...           | ...
 NAME_(N-1)    | char[20]      | Name (=Id) of the instrument/tracker
 TYPE_(N-1)    | uint8         | Type of instrument for #0
 (--)          | uint8         | Reserved
 POSITION_(N-1)| float32[3]    | (X, Y, Z)
 QUATERNION_(N-1)| float32[4]  | Quaternion (QX, QY, QZ, W)

- TYPE_X should be one of the followings:
  - 1: tracker
  - 2: 6D instrument (regular instrument)
  - 3: 3D instrument (only tip of the instrument defined)
  - 4: 5D instrument (tip and handle are defined, but not the normal vector)

GET_QTDATA
-------------------

 Data         | Type          | Description
--------------|---------------|-------------------------------------------------
              |               |

STT_QTDATA
-------------------

 Data         | Type          | Description
--------------|---------------|-------------------------------------------------
 STATUS       | uint8         | 0: Success; 1: Error
 RESOL        | uint32        | Minimum time between two frames. Use 0 for as fast as possible. If e.g. 50 ms is specified, the maximum update rate will be 20 Hz.
 COORD_NAME   | char[32]      | Name of coordinate system to use. Can be empty for default coordinate system. (not included if action = 2)


STP_QTDATA
-------------------

 Data         | Type          | Description
--------------|---------------|-------------------------------------------------
              |               |


RTS_QDATA
-------------------

 Data         | Type          | Description
--------------|---------------|-------------------------------------------------
 STATUS       | uint8         | 0: Success; 1: Error


Implementations
===================

* [igtlQuaternionTrackingDataMessage.h](/Source/igtlQuaternionTrackingDataMessage.h)
* [igtlQuaternionTrackingDataMessage.cxx](/Source/igtlQuaternionTrackingDataMessage.cxx)

Contributors
===================

* Alexander Schaal