File: position.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 (74 lines) | stat: -rw-r--r-- 2,166 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
[Back to Index](/Documents/Protocol/index.md)

Position Message
================

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


Summary
=======

The POSITION message type is used to transfer position and orientation
information. The data are a combination of three-dimensional vector for the position
and quaternion for the orientation. Although equivalent position and orientation
can be described with the TRANSFORM data type, the POSITION data type has the
advantage of smaller data size (19%). It is, therefore, more suitable for pushing
high frame-rate data from tracking devices.

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

POSITION
--------

 Data         | Type          | Description
--------------|---------------|-------------------------------------------------
 X            | float32       | X position in millimeter
 Y            | float32       | Y position in millimeter
 Z            | float32       | Z position in millimeter
 OX           | float32       | X element in quaternion
 OY           | float32       | Y element in quaternion
 OZ           | float32       | Z element in quaternion
 W            | float32       | W element in quaternion

GET_POSITION
-------------------

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

STT_POSITION
-------------------

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

STP_POSITION
-------------------

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

RTS_POSITION
-------------------

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


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

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

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

* Junichi Tokuda