summaryrefslogtreecommitdiffhomepage
path: root/eyeware-beam-sdk/docs/getting_started.html
blob: cdc0460ebfc477d5b83f9590fb57895a874924a5 (plain)
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372


<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Getting started &mdash; Beam SDK 1.1.0 documentation</title>
  

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />

  
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="API overview" href="api_overview.html" />
    <link rel="prev" title="Introduction" href="introduction.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #48447E" >
          

          
            <a href="index.html" class="icon icon-home"> Beam SDK
          

          
          </a>

          
            
            
              <div class="version">
                1.1.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#python-example">Python example</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#explanation">Explanation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_overview.html">API overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="redistribution.html">Redistributing a Beam client application</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Beam SDK</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>Getting started</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/getting_started.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="toctree-wrapper compound">
</div>
<div class="section" id="getting-started">
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>The <a class="reference external" href="https://beam.eyeware.tech">Beam application</a> is installed on your system;</p></li>
<li><p>you have an active subscription, which makes you able to receive head and eye tracking data;</p></li>
<li><p>you run the calibration procedure within the Beam application at least once.</p></li>
</ul>
<p>In addition, if you want to use the Python API, you need:</p>
<ul class="simple">
<li><p>Python 3.6;</p></li>
<li><p>NumPy;</p></li>
<li><p>adding <code class="docutils literal notranslate"><span class="pre">&lt;YOUR_BEAM_SDK_INSTALLATION_FOLDER&gt;/API/python</span></code> to your <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code>.</p></li>
</ul>
</div>
<div class="section" id="python-example">
<h2>Python example<a class="headerlink" href="#python-example" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">eyeware.client</span> <span class="kn">import</span> <span class="n">TrackerClient</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>

<span class="c1"># Build tracker client, to establish a communication with the tracker server (an Eyeware application).</span>
<span class="c1">#</span>
<span class="c1"># Constructing the tracker client object without arguments sets a default server hostname and port which</span>
<span class="c1"># work fine in many configurations.</span>
<span class="c1"># However, it is possible to set a specific hostname and port, depending on your setup and network.</span>
<span class="c1"># See the TrackerClient API reference for further information.</span>
<span class="n">tracker</span> <span class="o">=</span> <span class="n">TrackerClient</span><span class="p">()</span>

<span class="c1"># Run forever, until we press ctrl+c</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
    <span class="c1"># Make sure that the connection with the tracker server (Eyeware application) is up and running.</span>
    <span class="k">if</span> <span class="n">tracker</span><span class="o">.</span><span class="n">connected</span><span class="p">:</span>

        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;  * Head Pose:&quot;</span><span class="p">)</span>
        <span class="n">head_pose</span> <span class="o">=</span> <span class="n">tracker</span><span class="o">.</span><span class="n">get_head_pose_info</span><span class="p">()</span>
        <span class="n">head_is_lost</span> <span class="o">=</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">is_lost</span>
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Lost track:       &quot;</span><span class="p">,</span> <span class="n">head_is_lost</span><span class="p">)</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">head_is_lost</span><span class="p">:</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Session ID:       &quot;</span><span class="p">,</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">track_session_uid</span><span class="p">)</span>
            <span class="n">rot</span> <span class="o">=</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">transform</span><span class="o">.</span><span class="n">rotation</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Rotation:          |</span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2">|&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rot</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;                           |</span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2">|&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rot</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;                           |</span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2">|&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rot</span><span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span>
            <span class="n">tr</span> <span class="o">=</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">transform</span><span class="o">.</span><span class="n">translation</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Translation:       &lt;x=</span><span class="si">%5.3f</span><span class="s2"> m, y=</span><span class="si">%5.3f</span><span class="s2"> m, z=</span><span class="si">%5.3f</span><span class="s2"> m&gt;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">tr</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">tr</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">tr</span><span class="p">[</span><span class="mi">2</span><span class="p">]))</span>

        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;  * Gaze on Screen:&quot;</span><span class="p">)</span>
        <span class="n">screen_gaze</span> <span class="o">=</span> <span class="n">tracker</span><span class="o">.</span><span class="n">get_screen_gaze_info</span><span class="p">()</span>
        <span class="n">screen_gaze_is_lost</span> <span class="o">=</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">is_lost</span>
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Lost track:       &quot;</span><span class="p">,</span> <span class="n">screen_gaze_is_lost</span><span class="p">)</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">screen_gaze_is_lost</span><span class="p">:</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Screen ID:        &quot;</span><span class="p">,</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">screen_id</span><span class="p">)</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Coordinates:       &lt;x=</span><span class="si">%5.3f</span><span class="s2"> px,   y=</span><span class="si">%5.3f</span><span class="s2"> px&gt;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">screen_gaze</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">y</span><span class="p">))</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Confidence:       &quot;</span><span class="p">,</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">confidence</span><span class="p">)</span>

        <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span> <span class="o">/</span> <span class="mi">30</span><span class="p">)</span>  <span class="c1"># We expect tracking data at 30 Hz</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="c1"># Print a message every MESSAGE_PERIOD_IN_SECONDS seconds</span>
        <span class="n">MESSAGE_PERIOD_IN_SECONDS</span> <span class="o">=</span> <span class="mi">2</span>
        <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">MESSAGE_PERIOD_IN_SECONDS</span> <span class="o">-</span> <span class="n">time</span><span class="o">.</span><span class="n">monotonic</span><span class="p">()</span> <span class="o">%</span> <span class="n">MESSAGE_PERIOD_IN_SECONDS</span><span class="p">)</span>
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;No connection with tracker server&quot;</span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h3>
<p>Running the example code in a terminal will start printing information in real time.
There will be a lot of prints, one for each frame.
Let us zoom on the printed output associated to one frame only:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">*</span> <span class="n">Head</span> <span class="n">Pose</span><span class="p">:</span>
    <span class="o">-</span> <span class="n">Lost</span> <span class="n">track</span><span class="p">:</span>        <span class="kc">False</span>
    <span class="o">-</span> <span class="n">Session</span> <span class="n">ID</span><span class="p">:</span>        <span class="mi">1</span>
    <span class="o">-</span> <span class="n">Rotation</span><span class="p">:</span>          <span class="o">|-</span><span class="mf">0.999</span> <span class="o">-</span><span class="mf">0.005</span> <span class="o">-</span><span class="mf">0.045</span><span class="o">|</span>
                         <span class="o">|-</span><span class="mf">0.008</span> <span class="mf">0.999</span> <span class="mf">0.051</span><span class="o">|</span>
                         <span class="o">|</span><span class="mf">0.045</span> <span class="mf">0.051</span> <span class="o">-</span><span class="mf">0.998</span><span class="o">|</span>
    <span class="o">-</span> <span class="n">Translation</span><span class="p">:</span>       <span class="o">&lt;</span><span class="n">x</span><span class="o">=</span><span class="mf">0.166</span> <span class="n">m</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mf">0.181</span> <span class="n">m</span><span class="p">,</span> <span class="n">z</span><span class="o">=</span><span class="mf">0.260</span> <span class="n">m</span><span class="o">&gt;</span>
<span class="o">*</span> <span class="n">Gaze</span> <span class="n">on</span> <span class="n">Screen</span><span class="p">:</span>
    <span class="o">-</span> <span class="n">Lost</span> <span class="n">track</span><span class="p">:</span>        <span class="kc">False</span>
    <span class="o">-</span> <span class="n">Screen</span> <span class="n">ID</span><span class="p">:</span>         <span class="mi">0</span>
    <span class="o">-</span> <span class="n">Coordinates</span><span class="p">:</span>       <span class="o">&lt;</span><span class="n">x</span><span class="o">=</span><span class="mf">698.000</span> <span class="n">px</span><span class="p">,</span>   <span class="n">y</span><span class="o">=</span><span class="mf">149.000</span> <span class="n">px</span><span class="o">&gt;</span>
    <span class="o">-</span> <span class="n">Confidence</span><span class="p">:</span>        <span class="n">TrackingConfidence</span><span class="o">.</span><span class="n">HIGH</span>
</pre></div>
</div>
<p>For the meaning of the returned fields, refer to the section <a class="reference internal" href="api_overview.html#api-overview"><span class="std std-ref">API overview</span></a>.</p>
</div>
</div>
<div class="section" id="explanation">
<h2>Explanation<a class="headerlink" href="#explanation" title="Permalink to this headline"></a></h2>
<p>When creating a Python script with the purpose of consuming head and eye tracking information from Beam SDK, you must ensure that the basic classes are correctly imported:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">eyeware.client</span> <span class="kn">import</span> <span class="n">TrackerClient</span>
</pre></div>
</div>
<p>We can build a <code class="docutils literal notranslate"><span class="pre">TrackerClient</span></code> object, which is the main entry point of Beam SDK (see <a class="reference internal" href="api_overview.html#api-overview"><span class="std std-ref">API overview</span></a> for further details):</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tracker</span> <span class="o">=</span> <span class="n">TrackerClient</span><span class="p">()</span>
</pre></div>
</div>
<p>Then, we verify that the connection between our client object and the tracker server (Eyeware application) is up and running as follows:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">tracker</span><span class="o">.</span><span class="n">connected</span><span class="p">:</span>
</pre></div>
</div>
<p>and we are now ready to receive head and gaze tracking data, doing something with that data.</p>
<p>Let us start from the head tracking part.
First, we will retrieve the head tracking information data structure.
Then, we will check whether tracking information is valid for the current frame.
In code:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;  * Head Pose:&quot;</span><span class="p">)</span>
<span class="n">head_pose</span> <span class="o">=</span> <span class="n">tracker</span><span class="o">.</span><span class="n">get_head_pose_info</span><span class="p">()</span>
<span class="n">head_is_lost</span> <span class="o">=</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">is_lost</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Lost track:       &quot;</span><span class="p">,</span> <span class="n">head_is_lost</span><span class="p">)</span>
</pre></div>
</div>
<p>If the head tracking information is indeed valid (i.e., head tracking was <em>not lost</em>), then we retrieve the 3D coordinates of the tracked person’s head:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="ow">not</span> <span class="n">head_is_lost</span><span class="p">:</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Session ID:       &quot;</span><span class="p">,</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">track_session_uid</span><span class="p">)</span>
    <span class="n">rot</span> <span class="o">=</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">transform</span><span class="o">.</span><span class="n">rotation</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Rotation:          |</span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2">|&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rot</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;                           |</span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2">|&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rot</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;                           |</span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2"> </span><span class="si">%5.3f</span><span class="s2">|&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rot</span><span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">rot</span><span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span>
    <span class="n">tr</span> <span class="o">=</span> <span class="n">head_pose</span><span class="o">.</span><span class="n">transform</span><span class="o">.</span><span class="n">translation</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Translation:       &lt;x=</span><span class="si">%5.3f</span><span class="s2"> m, y=</span><span class="si">%5.3f</span><span class="s2"> m, z=</span><span class="si">%5.3f</span><span class="s2"> m&gt;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">tr</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">tr</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">tr</span><span class="p">[</span><span class="mi">2</span><span class="p">]))</span>
</pre></div>
</div>
<p>For details about the rotation and translation notation, refer to the section <a class="reference internal" href="api_overview.html#api-overview"><span class="std std-ref">API overview</span></a>.</p>
<p>Now, we want to get screen gaze tracking information.
This follows the same logic that we applied for head tracking information.
First, retrieve the screen gaze information data structure.
Then, check the data validity (whether tracking is <em>not lost</em>):</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;  * Gaze on Screen:&quot;</span><span class="p">)</span>
<span class="n">screen_gaze</span> <span class="o">=</span> <span class="n">tracker</span><span class="o">.</span><span class="n">get_screen_gaze_info</span><span class="p">()</span>
<span class="n">screen_gaze_is_lost</span> <span class="o">=</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">is_lost</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Lost track:       &quot;</span><span class="p">,</span> <span class="n">screen_gaze_is_lost</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">screen_gaze_is_lost</span><span class="p">:</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Screen ID:        &quot;</span><span class="p">,</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">screen_id</span><span class="p">)</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Coordinates:       &lt;x=</span><span class="si">%5.3f</span><span class="s2"> px,   y=</span><span class="si">%5.3f</span><span class="s2"> px&gt;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">screen_gaze</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">y</span><span class="p">))</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;      - Confidence:       &quot;</span><span class="p">,</span> <span class="n">screen_gaze</span><span class="o">.</span><span class="n">confidence</span><span class="p">)</span>
</pre></div>
</div>
<p>The rest of the example code is about printing head and gaze tracking data numbers on the terminal.
Printing those numbers, by itself, is not very useful or interesting.
Instead, you can exploit the Beam SDK tracking data for building your own creative applications!
Let us know how it goes at <a class="reference external" href="mailto:contact&#37;&#52;&#48;eyeware&#46;tech">contact<span>&#64;</span>eyeware<span>&#46;</span>tech</a>.
We would love to hear about your projects.</p>
</div>
</div>


           </div>
           
          </div>
          <footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
        <a href="api_overview.html" class="btn btn-neutral float-right" title="API overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
        <a href="introduction.html" class="btn btn-neutral float-left" title="Introduction" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2021, Eyeware Tech SA.

    </p>
  </div>
    
    
    
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>