-
Notifications
You must be signed in to change notification settings - Fork 10
/
opengaze.py
1428 lines (1146 loc) · 43.2 KB
/
opengaze.py
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# PyOpenGaze: Python wrapper for the OpenGaze API.
#
# author: Edwin Dalmaijer
# email: edwin.dalmaijer@psy.ox.ac.uk
#
# Version 1 (27-Apr-2016)
import os
import copy
import time
import socket
import datetime
import lxml.etree
from multiprocessing import Queue
from threading import Event, Lock, Thread
# TODO: OpenGazeConnection
# Thread that monitors whether the other threads are still alive, and that
# checks whether the connection is still alive.
# Locks for the log and the DEBUG log.
# # # # #
# OPENGAZE API WRAPPER
# The OpenGazeTracker class communicates to the GazePoint Server through
# a TCP/IP socket.
class OpenGazeTracker:
def __init__(self, ip='127.0.0.1', port=4242, logfile='default.tsv', \
debug=False):
"""The OpenGazeConnection class communicates to the GazePoint
server through a TCP/IP socket. Incoming samples will be written
to a log at the specified path.
Keyword Arguments
ip - The IP address of the computer that is running the
OpenGaze server. This will usually be the localhost at
127.0.0.1. Type: str. Default = '127.0.0.1'
port - The port number that the OpenGaze server is on; usually
this will be 4242. Type: int. Default = 4242
logfile - The path to the intended log file, including a
file extension ('.tsv'). Type: str. Default =
'default.tsv'
debug - Boolean that determines whether DEBUG mode should be
active (True) or not (False). In DEBUG mode, all sent
and received messages are logged to a file. Type: bool.
Default = False
"""
# DEBUG
self._debug = debug
# Open a new debug file.
if self._debug:
dt = time.strftime("%Y-%m-%d_%H-%M-%S")
self._debuglog = open('debug_%s.txt' % (dt), 'w')
self._debuglog.write("OPENGAZE PYTHON DEBUG LOG %s\n" % (dt))
self._debugcounter = 0
self._debugconsolidatefreq = 100
# CONNECTION
# Save the ip and port numbers.
self.host = ip
self.port = port
# Start a new TCP/IP socket. It is curcial that it has a timeout,
# as timeout exceptions will be handled gracefully, and are in fact
# necessary to prevent the incoming Thread from freezing.
self._debug_print("Connecting to %s (%s)..." % (self.host, self.port))
self._sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self._sock.connect((self.host, self.port))
self._sock.settimeout(1.0)
self._debug_print("Successfully connected!")
self._maxrecvsize = 4096
# Create a socket Lock to prevent simultaneous access.
self._socklock = Lock()
# Create an event that should remain set until the connection is
# closed. (This is what keeps the Threads running.)
self._connected = Event()
self._connected.set()
# Set the current calibration point.
self._current_calibration_point = None
# LOGGING
self._debug_print("Opening new logfile '%s'" % (logfile))
# Open a new log file.
self._logfile = open(logfile, 'w')
# Write the header to the log file.
self._logheader = ['CNT', 'TIME', 'TIME_TICK', \
'FPOGX', 'FPOGY', 'FPOGS', 'FPOGD', 'FPOGID', 'FPOGV', \
'LPOGX', 'LPOGY', 'LPOGV', \
'RPOGX', 'RPOGY', 'RPOGV', \
'BPOGX', 'BPOGY', 'BPOGV', \
'LPCX', 'LPCY', 'LPD', 'LPS', 'LPV', \
'RPCX', 'RPCY', 'RPD', 'RPS', 'RPV', \
'LEYEX', 'LEYEY', 'LEYEZ', 'LPUPILD', 'LPUPILV', \
'REYEX', 'REYEY', 'REYEZ', 'RPUPILD', 'RPUPILV', \
'CX', 'CY', 'CS', \
'USER']
self._n_logvars = len(self._logheader)
self._logfile.write('\t'.join(self._logheader) + '\n')
# The log is consolidated (written to the disk) every N samples.
# This requires an internal counter (because we can't be sure the
# user turned on the 'CNT' sample counter), and a property that
# determines the consolidation frequency. This frequency can also
# be set to None, to never consolidate automatically.
self._logcounter = 0
self._log_consolidation_freq = 60
# Start a Queue for samples that need to be logged.
self._logqueue = Queue()
# Set an event that is set while samples should be logged, and
# unset while they shouldn't.
self._logging = Event()
self._logging.set()
# Set an event that signals is set when the logfile is ready to
# be closed.
self._log_ready_for_closing = Event()
self._log_ready_for_closing.clear()
# Start a Thread that writes queued samples to the log file.
self._logthread = Thread( \
target=self._process_logging,
name='PyGaze_OpenGazeConnection_logging', \
args=[])
# INCOMING
# Start a new dict for the latest incoming messages, and for
# incoming acknowledgements.
self._incoming = {}
self._acknowledgements = {}
# Create a Lock for the incoming message and acknowledgement dicts.
self._inlock = Lock()
self._acklock = Lock()
# Create an empty string for the current unfinished message. This
# is to prevent half a message being parsed when it is cut off
# between two 'self._sock.recv' calls.
self._unfinished = ''
# Start a new Thread that processes the incoming messages.
self._inthread = Thread( \
target=self._process_incoming, \
name='PyGaze_OpenGazeConnection_incoming', \
args=[])
# OUTGOING
# Start a new outgoing Queue (Thread safe, woop!).
self._outqueue = Queue()
# Set an event that is set when all queued outgoing messages have
# been processed.
self._sock_ready_for_closing = Event()
self._sock_ready_for_closing.clear()
# Create a new Thread that processes the outgoing queue.
self._outthread = Thread( \
target=self._process_outgoing, \
name='PyGaze_OpenGazeConnection_outgoing', \
args=[])
# Create a dict that will keep track of at what time which command
# was sent.
self._outlatest = {}
# Create a Lock to prevent simultaneous access to the outlatest
# dict.
self._outlock = Lock()
# RUN THREADS
# Set a signal that will kill all Threads when they receive it.
self._thread_shutdown_signal = 'KILL_ALL_HUMANS'
# Start the threads.
self._debug_print("Starting the logging thread.")
self._logthread.start()
self._debug_print("Starting the incoming thread.")
self._inthread.start()
self._debug_print("Starting the outgoing thread.")
self._outthread.start()
# SET UP LOGGING
# Wait for a bit to allow the Threads to start.
time.sleep(0.5)
# Enable the tracker to send ALL the things.
self.enable_send_counter(True)
self.enable_send_cursor(True)
self.enable_send_eye_left(True)
self.enable_send_eye_right(True)
self.enable_send_pog_best(True)
self.enable_send_pog_fix(True)
self.enable_send_pog_left(True)
self.enable_send_pog_right(True)
self.enable_send_pupil_left(True)
self.enable_send_pupil_right(True)
self.enable_send_time(True)
self.enable_send_time_tick(True)
self.enable_send_user_data(True)
# Reset the user-defined variable.
self.user_data("0")
def calibrate(self):
"""Calibrates the eye tracker.
"""
# Reset the calibration.
self.clear_calibration_result()
# Show the calibration screen.
self.calibrate_show(True)
# Start the calibration.
self.calibrate_start(True)
# Wait for the calibration result.
result = None
while result == None:
result = self.get_calibration_result()
time.sleep(0.1)
# Hide the calibration window.
self.calibrate_show(False)
return result
def sample(self):
# If there is no current record yet, return None.
self._inlock.acquire()
if 'REC' not in self._incoming.keys():
x = None
y = None
elif 'NO_ID' not in self._incoming['REC'].keys():
x = None
y = None
elif ('BPOGX' not in self._incoming['REC']['NO_ID'].keys()) or \
('BPOGY' not in self._incoming['REC']['NO_ID'].keys()):
x = None
y = None
else:
x = float(self._incoming['REC']['NO_ID']['BPOGX'])
y = float(self._incoming['REC']['NO_ID']['BPOGY'])
self._inlock.release()
# Return the (x,y) coordinate.
return x, y
def pupil_size(self):
"""Return the current pupil size.
"""
# If there is no current record yet, return None.
self._inlock.acquire()
if 'REC' not in self._incoming.keys():
psize = None
elif 'NO_ID' not in self._incoming['REC'].keys():
psize = None
elif ('LPV' not in self._incoming['REC']['NO_ID'].keys()) or \
('LPS' not in self._incoming['REC']['NO_ID'].keys()) or \
('RPV' not in self._incoming['REC']['NO_ID'].keys()) or \
('RPS' not in self._incoming['REC']['NO_ID'].keys()):
psize = None
# Compute the pupil size, and return it if there is valid data.
n = 0
psize = 0
if str(self._incoming['REC']['NO_ID']['LPV']) == '1':
psize += float(self._incoming['REC']['NO_ID']['LPS'])
n += 1
if str(self._incoming['REC']['NO_ID']['RPV']) == '1':
psize += float(self._incoming['REC']['NO_ID']['RPS'])
n += 1
self._inlock.release()
if n == 0:
psize = None
else:
psize = psize / float(n)
return psize
def log(self, message):
"""Logs a message to the log file. ONLY CALL THIS WHILE RECORDING
DATA!
"""
# Set the user-defined value.
i = copy.copy(self._logcounter)
self.user_data(message)
# Wait until a single sample is logged.
while self._logcounter <= i:
time.sleep(0.0001)
# Reset the user-defined value.
self.user_data("0")
def start_recording(self):
"""Start writing data to the log file.
"""
self.enable_send_data(True)
def stop_recording(self):
"""Pause writing data to the log file.
"""
self.enable_send_data(False)
def _debug_print(self, msg):
if self._debug:
self._debuglog.write('%s: %s\n' % \
(datetime.datetime.now().strftime("%H:%M:%S.%f"), msg))
if self._debugcounter % self._debugconsolidatefreq == 0:
self._debuglog.flush()
os.fsync(self._debuglog.fileno())
self._debugcounter += 1
def _format_msg(self, command, ID, values=None):
# Create the start of the formatted string.
xml = '<%s ID="%s" ' % (command.upper(), ID.upper())
# Add the values for each parameter.
if values:
for par, val in values:
xml += '%s="%s" ' % (par.upper(), val)
# Add the ending.
xml += '/>\r\n'
return xml
def _log_consolidation(self):
# Internal buffer to RAM.
self._logfile.flush()
# RAM to disk.
os.fsync(self._logfile.fileno())
def _log_sample(self, sample):
# Construct an empty line that has the same length as the log's
# header (this was computed in __init__).
line = self._n_logvars * ['']
# Loop through all keys in the dict.
for varname in sample.keys():
# Check if this is a logable variable.
if varname in self._logheader:
# Find the appropriate index in the line
line[self._logheader.index(varname)] = sample[varname]
self._logfile.write('\t'.join(line) + '\n')
def _parse_msg(self, xml):
e = lxml.etree.fromstring(xml)
return (e.tag, e.attrib)
def _process_logging(self):
self._debug_print("Logging Thread started.")
while not self._log_ready_for_closing.is_set():
# Get a new sample from the Queue.
sample = self._logqueue.get()
# Check if this is the shutdown signal.
if sample == self._thread_shutdown_signal:
# Signal that we're done logging all samples.
self._log_ready_for_closing.set()
# Break the while loop.
break
# Log the sample.
self._log_sample(sample)
# Consolidate the log if necessary.
if self._logcounter % self._log_consolidation_freq == 0:
self._log_consolidation()
# Increment the counter.
self._logcounter += 1
self._debug_print("Logging Thread ended.")
return
def _process_incoming(self):
self._debug_print("Incoming Thread started.")
while self._connected.is_set():
# Lock the socket to prevent other Threads from simultaneously
# accessing it.
self._socklock.acquire()
# Get new messages from the OpenGaze Server.
timeout = False
try:
instring = self._sock.recv(self._maxrecvsize)
except socket.timeout:
timeout = True
# Get a received timestamp.
t = time.time()
# Unlock the socket again.
self._socklock.release()
# Skip further processing if no new message came in.
if timeout:
self._debug_print("socket recv timeout")
continue
self._debug_print("Raw instring: %r" % (instring))
# Split the messages (they are separated by '\r\n').
messages = instring.split('\r\n')
# Check if there is currently an unfinished message.
if self._unfinished:
# Combine the currently unfinished message and the
# most recent incoming message.
messages[0] = copy.copy(self._unfinished) + messages[0]
# Reset the unfinished message.
self._unfinished = ''
# Check if the last message was actually complete.
if not messages[-1][-2:] == '/>':
self._unfinished = messages.pop(-1)
# Run through all messages.
for msg in messages:
self._debug_print("Incoming: %r" % (msg))
# Parse the message.
command, msgdict = self._parse_msg(msg)
# Check if the incoming message is an acknowledgement.
# Acknowledgements are also stored in a different dict,
# which is used to monitor whether sent messages are
# properly received.
if command == 'ACK':
self._acklock.acquire()
self._acknowledgements[msgdict['ID']] = copy.copy(t)
self._acklock.release()
# Acquire the Lock for the incoming dict, so that it
# won't be accessed at the same time.
self._inlock.acquire()
# Check if this command is already in the current dict.
if command not in self._incoming.keys():
self._incoming[command] = {}
# Some messages have no ID, for example 'REC' messages.
# We simply assign 'NO_ID' as the ID.
if 'ID' not in msgdict.keys():
msgdict['ID'] = 'NO_ID'
# Check if this ID is already in the current dict.
if msgdict['ID'] not in self._incoming[command].keys():
self._incoming[command][msgdict['ID']] = {}
# Add receiving time stamp, and the values for each
# parameter to the current dict.
self._incoming[command][msgdict['ID']]['t'] = \
copy.copy(t)
for par, val in msgdict.items():
self._incoming[command][msgdict['ID']][par] = \
copy.copy(val)
# Log sample if command=='REC' and when the logging
# event is set.
if command == 'REC' and self._logging.is_set():
self._logqueue.put(copy.deepcopy( \
self._incoming[command][msgdict['ID']]))
# Unlock the incoming dict again.
self._inlock.release()
self._debug_print("Incoming Thread ended.")
return
def _process_outgoing(self):
self._debug_print("Outgoing Thread started.")
while not self._sock_ready_for_closing.is_set():
# Get a new command from the Queue.
msg = self._outqueue.get()
# Check if this is the shutdown signal.
if msg == self._thread_shutdown_signal:
# Signal that we're done processing all the outgoing
# messages.
self._sock_ready_for_closing.set()
# Break the while loop.
break
self._debug_print("Outgoing: %r" % (msg))
# Lock the socket to prevent other Threads from simultaneously
# accessing it.
self._socklock.acquire()
# Send the command to the OpenGaze Server.
t = time.time()
self._sock.send(msg)
# Unlock the socket again.
self._socklock.release()
# Store a timestamp for the latest outgoing message.
self._outlock.acquire()
self._outlatest[msg] = copy.copy(t)
self._outlock.release()
self._debug_print("Outgoing Thread ended.")
return
def _send_message(self, command, ID, values=None, \
wait_for_acknowledgement=True, resend_timeout=3.0, maxwait=9.0):
# Format a message in an XML format that the Open Gaze API needs.
msg = self._format_msg(command, ID, values=values)
# Run until the message is acknowledged or a timeout occurs (or
# break if we're not supposed to wait for an acknowledgement.)
timeout = False
acknowledged = False
t0 = time.time()
while (not acknowledged) and (not timeout):
# Add the command to the outgoing Queue.
self._debug_print("Outqueue add: %r" % (msg))
self._outqueue.put(msg)
# Wait until an acknowledgement comes in.
if wait_for_acknowledgement:
sent = False
t1 = time.time()
while (time.time() - t1 < resend_timeout) and \
(not acknowledged):
# Check the outgoing queue for the sent message to
# appear.
if not sent:
self._outlock.acquire()
if msg in self._outlatest.keys():
t = copy.copy(self._outlatest[msg])
sent = True
self._debug_print("Outqueue sent: %r" \
% (msg))
self._outlock.release()
time.sleep(0.001)
# Check the incoming queue for the expected
# acknowledgement. (NOTE: This does not check
# whether the values of the incoming acknowlement
# match the sent message. Ideally, they should.)
else:
self._acklock.acquire()
if ID in self._acknowledgements.keys():
if self._acknowledgements[ID] >= t:
acknowledged = True
self._debug_print("Outqueue acknowledged: %r" \
% (msg))
self._acklock.release()
time.sleep(0.001)
# Check if there is a timeout.
if (not acknowledged) and \
(time.time() - t0 > maxwait):
timeout = True
break
# If we're not supposed to wait for an acknowledgement, break
# the while loop.
else:
break
return acknowledged, timeout
def close(self):
"""Closes the connection to the tracker, closes the log files, and
ends the Threads that process the incoming and outgoing messages,
and the logging of samples.
"""
# Reset the user-defined value.
self.user_data('0')
# Unset the self._connected event to stop the incoming Thread.
self._debug_print("Unsetting the connection event")
self._connected.clear()
# Queue the stop signal to stop the outgoing and logging Threads.
self._debug_print("Adding stop signal to outgoing Queue")
self._outqueue.put(self._thread_shutdown_signal)
self._debug_print("Adding stop signal to logging Queue")
self._logqueue.put(self._thread_shutdown_signal)
# Wait for the outgoing Queue to be fully processed.
self._debug_print("Waiting for the socket to close...")
self._sock_ready_for_closing.wait()
# Close the socket connection to the OpenGaze server.
self._debug_print("Closing socket connection...")
self._sock.close()
self._debug_print("Socket connection closed!")
# Wait for the log Queue to be fully processed.
self._debug_print("Waiting for the log to close...")
self._log_ready_for_closing.wait()
# Close the log file.
self._logfile.close()
self._debug_print("Log closed!")
# Join the Threads.
self._debug_print("Waiting for the Threads to join...")
self._outthread.join()
self._debug_print("Outgoing Thread joined!")
self._inthread.join()
self._debug_print("Incoming Thread joined!")
self._logthread.join()
self._debug_print("Logging Thread joined!")
# Close the DEBUG log.
if self._debug:
self._debuglog.write("END OF DEBUG LOG")
self._debuglog.close()
def enable_send_data(self, state):
"""Start (state=True) or stop (state=False) the streaming of data
from the server to the client.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_DATA', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_counter(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
the send counter in the data record string.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_COUNTER', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_time(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
the send time in the data record string.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_TIME', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_time_tick(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
the send time tick in the data record string.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_TIME_TICK', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_pog_fix(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
the point of gaze as determined by the tracker's fixation filter in
the data record string.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_POG_FIX', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_pog_left(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
the point of gaze of the left eye in the data record string.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_POG_LEFT', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_pog_right(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
the point of gaze of the right eye in the data record string.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_POG_RIGHT', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_pog_best(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
the 'best' point of gaze in the data record string. This is based
on the average of the left and right POG if both eyes are available,
or on the value of the one available eye.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_POG_BEST', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_pupil_left(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
pupil data on the left eye in the data record string. This data
consists of the following:
LPCX: The horizontal coordinate of the left eye pupil in the camera
image, as a fraction of the camera size.
LPCY: The vertical coordinate of the left eye pupil in the camera
image, as a fraction of the camera size.
LPD: The left eye pupil's diameter in pixels.
LPS: The scale factor of the left eye pupil (unitless). Value
equals 1 at calibration depth, is less than 1 when the user
is closer to the eye tracker and greater than 1 when the user
is further away.
LPV: The valid flag with a value of 1 if the data is valid, and 0
if it is not.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_PUPIL_LEFT', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_pupil_right(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
pupil data on the right eye in the data record string. This data
consists of the following:
RPCX: The horizontal coordinate of the right eye pupil in the camera
image, as a fraction of the camera size.
RPCY: The vertical coordinate of the right eye pupil in the camera
image, as a fraction of the camera size.
RPD: The right eye pupil's diameter in pixels.
RPS: The scale factor of the right eye pupil (unitless). Value
equals 1 at calibration depth, is less than 1 when the user
is closer to the eye tracker and greater than 1 when the user
is further away.
RPV: The valid flag with a value of 1 if the data is valid, and 0
if it is not.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_PUPIL_RIGHT', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_eye_left(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
3D data on left eye in the data record string. This data consists
of the following:
LEYEX: The horizontal coordinate of the left eye in 3D space with
respect to the camera focal point, in meters.
LEYEY: The vertical coordinate of the left eye in 3D space with
respect to the camera focal point, in meters.
LEYEZ: The depth coordinate of the left eye in 3D space with
respect to the camera focal point, in meters.
LPUPILD: The diameter of the left eye pupil in meters.
LPUPILV: The valid flag with a value of 1 if the data is valid, and
0 if it is not.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_EYE_LEFT', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_eye_right(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
3D data on right eye in the data record string. This data consists
of the following:
REYEX: The horizontal coordinate of the right eye in 3D space with
respect to the camera focal point, in meters.
REYEY: The vertical coordinate of the right eye in 3D space with
respect to the camera focal point, in meters.
REYEZ: The depth coordinate of the right eye in 3D space with
respect to the camera focal point, in meters.
RPUPILD: The diameter of the right eye pupil in meters.
RPUPILV: The valid flag with a value of 1 if the data is valid, and
0 if it is not.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_EYE_RIGHT', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_cursor(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
data on the mouse cursor in the data record string. This data
consists of the following:
CX: The horizontal coordinate of the mouse cursor, as a percentage
of the screen resolution.
CY: The vertical coordinate of the mouse cursor, as a percentage
of the screen resolution.
CS: The mouse cursor state, 0 for steady state, 1 for left button
down, 2 for rigght button down.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_CURSOR', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def enable_send_user_data(self, state):
"""Enable (state=True) or disable (state=False) the inclusion of
user-defined variables in the data record string. User-defined
variables can be set with the 'user_data' method.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'ENABLE_SEND_USER_DATA', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def calibrate_start(self, state):
"""Starts (state=1) or stops (state=0) the calibration procedure.
Make sure to call the 'calibrate_show' function beforehand, or to
implement your own calibration visualisation; otherwise a call to
this function will make the calibration run in the background.
"""
# Reset the current calibration point.
if state:
self._current_calibration_point = 0
else:
self._current_calibration_point = None
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'CALIBRATE_START', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def calibrate_show(self, state):
"""Shows (state=1) or hides (state=0) the calibration window on the
tracker's display window. While showing the calibration window, you
can call 'calibrate_start' to run the calibration procedure.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'CALIBRATE_SHOW', \
values=[('STATE', int(state))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def calibrate_timeout(self, value):
"""Set the duration of the calibration point (not including the
animation time) in seconds. The value can be an int or a float.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'CALIBRATE_TIMEOUT', \
values=[('VALUE', float(value))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def calibrate_delay(self, value):
"""Set the duration of the calibration animation (before
calibration at a point begins) in seconds. The value can be an int
or a float.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'CALIBRATE_DELAY', \
values=[('VALUE', float(value))], \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def calibrate_result_summary(self):
"""Returns a summary of the calibration results, which consists of
the following values:
AVE_ERROR: Average error over all calibrated points.
VALID_POINTS: Number of successfully calibrated points.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('GET', \
'CALIBRATE_RESULT_SUMMARY', \
values=None, \
wait_for_acknowledgement=True)
# Return the results.
ave_error = None
valid_points = None
if acknowledged:
self._inlock.acquire()
ave_error = copy.copy( \
self._incoming['ACK']['CALIBRATE_RESULT_SUMMARY']['AVE_ERROR'])
valid_points = copy.copy( \
self._incoming['ACK']['CALIBRATE_RESULT_SUMMARY']['VALID_POINTS'])
self._inlock.release()
return ave_error, valid_points
def calibrate_clear(self):
"""Clear the internal list of calibration points.
"""
# Send the message (returns after the Server acknowledges receipt).
acknowledged, timeout = self._send_message('SET', \
'CALIBRATE_CLEAR', \
values=None, \
wait_for_acknowledgement=True)
# Return a success Boolean.
return acknowledged and (timeout==False)
def calibrate_reset(self):
"""Reset the internal list of calibration points to the default
values.
"""