source: trunk/Puzzlebox/Synapse/Session.py @ 394

Last change on this file since 394 was 394, checked in by sc, 8 years ago

session handling cleanup

File size: 18.4 KB
Line 
1# -*- coding: utf-8 -*-
2
3# Copyright Puzzlebox Productions, LLC (2010-2012)
4#
5# This code is released under the GNU Pulic License (GPL) version 2
6# For more information please refer to http://www.gnu.org/copyleft/gpl.html
7
8__changelog__ = """\
9Last Update: 2012.05.07
10"""
11
12__todo__ = """
13"""
14
15### IMPORTS ###
16import os, sys, time
17
18import Puzzlebox.Synapse.Configuration as configuration
19
20if configuration.ENABLE_PYSIDE:
21        try:
22                import PySide as PyQt4
23                from PySide import QtCore, QtGui
24        except Exception, e:
25                print "ERROR: [Synapse:Session] Exception importing PySide:",
26                print e
27                configuration.ENABLE_PYSIDE = False
28        else:
29                print "INFO: [Synapse:Session] Using PySide module"
30
31if not configuration.ENABLE_PYSIDE:
32        print "INFO: [Synapse:Session] Using PyQt4 module"
33        from PyQt4 import QtCore, QtGui
34
35
36try:
37        import cPickle as pickle
38except:
39        import pickle
40
41
42#####################################################################
43# Globals
44#####################################################################
45
46DEBUG = configuration.DEBUG
47
48DEFAULT_SIGNAL_LEVEL_MESSAGE = \
49        {"poorSignalLevel": 0}
50                # A quantifier of the quality of the brainwave signal.
51                # This is an integer value that is generally in the
52                # range of 0 to 200, with 0 indicating a
53                # good signal and 200 indicating an off-head state.
54
55DEFAULT_EEG_POWER_MESSAGE = \
56        {"eegPower": { \
57                'delta': 0, \
58                'theta': 0, \
59                'lowAlpha': 0, \
60                'highAlpha': 0, \
61                'lowBeta': 0, \
62                'highBeta': 0, \
63                'lowGamma': 0, \
64                'highGamma': 0, \
65                }, \
66        } # A container for the EEG powers. These may
67          # be either integer or floating-point values.
68          # Maximum values are undocumented but assumed to be 65535
69
70DEFAULT_ESENSE_MESSAGE = \
71        {"eSense": { \
72                'attention': 0, \
73                'meditation': 0, \
74                }, \
75        } # A container for the eSense™ attributes.
76          # These are integer values between 0 and 100,
77          # where 0 is perceived as a lack of that attribute
78          # and 100 is an excess of that attribute.
79
80DEFAULT_BLINK_MESSAGE = {"blinkStrength": 255}
81        # The strength of a detected blink. This is
82        # an integer in the range of 0-255.
83
84DEFAULT_RAWEEG_MESSAGE = {"rawEeg": 255}
85        # The raw data reading off the forehead sensor.
86        # This may be either an integer or a floating-point value.
87
88DEFAULT_PACKET = {}
89DEFAULT_PACKET.update(DEFAULT_EEG_POWER_MESSAGE)
90DEFAULT_PACKET.update(DEFAULT_SIGNAL_LEVEL_MESSAGE)
91DEFAULT_PACKET.update(DEFAULT_ESENSE_MESSAGE)
92
93PACKET_MINIMUM_TIME_DIFFERENCE_THRESHOLD = 0.75
94
95#####################################################################
96# Classes
97#####################################################################
98
99class puzzlebox_synapse_session(QtGui.QWidget):
100       
101        def __init__(self, log, \
102                     DEBUG=DEBUG, \
103                     parent=None, \
104                     ):
105               
106                self.log = log
107                self.DEBUG = DEBUG
108                self.parent=parent
109               
110                if self.parent == None:
111                        QtGui.QWidget.__init__(self, parent)
112                        #self.setupUi(self)
113               
114                        self.configureSettings()
115                        self.connectWidgets()
116               
117                self.name = "Synapse:Session"
118               
119               
120                if (sys.platform == 'win32'):
121                        self.homepath = os.path.join( \
122                           os.environ['HOMEDRIVE'], \
123                           os.environ['HOMEPATH'], \
124                           'Desktop')
125                elif (sys.platform == 'darwin'):
126                        desktop = os.path.join(os.environ['HOME'], 'Documents')
127                        if os.path.exists(desktop):
128                                self.homepath = desktop
129                        else:
130                                self.homepath = os.environ['HOME']
131                else:
132                        desktop = os.path.join(os.environ['HOME'], 'Desktop')
133                        if os.path.exists(desktop):
134                                self.homepath = desktop
135                        else:
136                                self.homepath = os.environ['HOME']
137               
138               
139                if not os.path.exists(self.homepath):
140                        if self.DEBUG:
141                                print "WARNING: [Synapse:Session] User default path not found"
142                        self.homepath = os.getcwd()
143       
144       
145        ##################################################################
146       
147        def configureSettings(self):
148               
149                pass
150       
151       
152        ##################################################################
153       
154        def connectWidgets(self):
155               
156                pass
157       
158       
159        ##################################################################
160       
161        def updateProfileSessionStatus(self, source=None, target=None):
162               
163                session_time = self.calculateSessionTime()
164               
165                #if source == None:
166                        #if self.parent == None:
167                                #source = self
168                        #else:
169                                #source = self.parent
170               
171                #if target == None:
172                        #if self.parent == None:
173                                #target = self
174                        #else:
175                                #target = self.parent
176               
177                #target.textLabelSessionTime.setText(session_time)
178                self.textLabelSessionTime.setText(session_time)
179               
180                try:
181                        #target.textLabelPacketsReceived.setText( "%i" % \
182                                #source.synapseServer.protocol.packet_count)
183                        self.textLabelPacketsReceived.setText( "%i" % \
184                                self.synapseServer.protocol.packet_count)
185                except:
186                        pass
187               
188                try:
189                        #target.textLabelPacketsDropped.setText( "%i" % \
190                                #source.synapseServer.protocol.bad_packets)
191                        self.textLabelPacketsDropped.setText( "%i" % \
192                                self.synapseServer.protocol.bad_packets)
193                except:
194                        pass
195       
196       
197        ##################################################################
198       
199        def calculateSessionTime(self):
200               
201                session_time = self.getSessionTime()
202               
203                session_time = time.time() - session_time
204                session_time = int(session_time)
205                session_time = self.convert_seconds_to_datetime(session_time)
206               
207                return (session_time)
208       
209       
210        ##################################################################
211       
212        def getSessionTime(self):
213               
214                return (self.synapseServer.session_start_timestamp)
215       
216       
217        ##################################################################
218       
219        def collectData(self, source=None, target=None):
220               
221                if source == None:
222                        if self.parent == None:
223                                source = self
224                        else:
225                                source = self.parent
226               
227                if target == None:
228                        if self.parent == None:
229                                target = self
230                        else:
231                                target = self.parent
232               
233                data = {}
234               
235                data['rawEeg'] = source.packets['rawEeg']
236                data['signals'] = source.packets['signals']
237               
238                data['sessionTime'] = self.calculateSessionTime()
239               
240                data['profileName'] = str(target.lineEditSessionProfile.text())
241               
242                return(data)
243       
244       
245        ##################################################################
246       
247        def parseTimeStamp(self, timestamp, local_version=False, truncate_time_zone=False):
248               
249                try:
250                        decimal = '%f' % timestamp
251                        decimal = decimal.split('.')[1]
252                except:
253                        decimal = '0'
254               
255                localtime = time.localtime(timestamp)
256               
257                if local_version:
258                        date = time.strftime('%x', localtime)
259                        localtime = time.strftime('%X', localtime)
260               
261                elif truncate_time_zone:
262                        date = time.strftime('%Y-%m-%d', localtime)
263                        localtime = time.strftime('%H:%M:%S', localtime)
264                        localtime = '%s.%s' % (localtime, decimal[:3])
265               
266                else:
267                        date = time.strftime('%Y-%m-%d', localtime)
268                        localtime = time.strftime('%H:%M:%S', localtime)
269                        localtime = '%s.%s %s' % (localtime, decimal, \
270                                       time.strftime('%Z', time.localtime(timestamp)))
271               
272               
273                return(date, localtime)
274       
275       
276        ##################################################################
277       
278        def saveData(self, source=None, target=None, output_file=None, use_default=False):
279               
280                if source == None:
281                        if self.parent == None:
282                                source = self
283                        else:
284                                source = self.parent
285               
286                if target == None:
287                        if self.parent == None:
288                                target = self
289                        else:
290                                target = self.parent
291               
292                data = self.collectData(source=source, target=target)
293               
294                (date, localtime) = self.parseTimeStamp(time.time())
295               
296                default_filename = '%s %s.synapse' % (date, \
297                                      target.lineEditSessionProfile.text())
298                                     
299                default_filename = os.path.join(self.homepath, default_filename)
300               
301                if output_file == None:
302                       
303                        # use_default controls whether or not a file is automatically saves using the
304                        # default name and path (as opposed to raising a GUI file selection menu)
305                        # whenever an explicit filepath is not defined
306                        if use_default:
307                                       
308                                        output_file = default_filename
309                       
310                        else:
311                       
312                                output_file = QtGui.QFileDialog.getSaveFileName(parent=target, \
313                                                 caption="Save Session Data to File", \
314                                                 dir=default_filename, \
315                                                 filter="Puzzlebox Synapse Data File (*.synapse)")
316                               
317                                try:
318                                        output_file = output_file[0]
319                                except:
320                                        output_file = ''
321               
322               
323                if output_file == '':
324                        return
325               
326                file = open(str(output_file), 'w')
327                pickle.dump(data, file)
328                file.close()
329       
330       
331        ##################################################################
332       
333        def exportData(self, parent=None, source=None, target=None, output_file=None, use_default=False):
334               
335                if parent == None:
336                        if self.parent == None:
337                                parent = self
338                        else:
339                                parent = self.parent
340               
341                if source == None:
342                        if self.parent == None:
343                                source = self
344                        else:
345                                source = self.parent
346               
347                if target == None:
348                        if self.parent == None:
349                                target = self
350                        else:
351                                target = self.parent
352               
353               
354                (date, localtime) = self.parseTimeStamp(time.time())
355               
356                default_filename = '%s %s.csv' % (date, \
357                                      target.lineEditSessionProfile.text())
358               
359                default_filename = os.path.join(target.homepath, default_filename)
360               
361               
362                if output_file == None:
363                       
364                        # use_default controls whether or not a file is automatically saves using the
365                        # default name and path (as opposed to raising a GUI file selection menu)
366                        # whenever an explicit filepath is not defined
367                        if use_default:
368                                       
369                                        output_file = default_filename
370                       
371                        else:
372                                output_file = QtGui.QFileDialog.getSaveFileName(parent=target, \
373                                                 caption="Export Session Data to File", \
374                                                 dir=default_filename, \
375                                                 filter="CSV File (*.csv);;Text File (*.txt)")
376                               
377                                try:
378                                        output_file = output_file[0]
379                                except:
380                                        output_file = ''
381               
382               
383                if output_file == '':
384                        return
385               
386               
387                if str(output_file).endswith('.csv'):
388                       
389                        outputData = self.exportDataToCSV(parent=parent, source=source, target=target)
390               
391               
392                else:
393                       
394                        try:
395                                outputData = self.textEditDebugConsole.toPlainText()
396                        except:
397                                outputData = self.exportDataToCSV()
398               
399               
400                file = open(str(output_file), 'w')
401                file.write(outputData)
402                file.close()
403       
404       
405        ##################################################################
406       
407        def exportDataToCSV(self, parent=None, source=None, target=None):
408               
409                # handle importing class from multiple sources
410                if parent == None:
411                        if self.parent == None:
412                                parent = self
413                        else:
414                                parent = self.parent
415               
416                if source == None:
417                        if self.parent == None:
418                                source = self
419                        else:
420                                source = self.parent
421               
422                if target == None:
423                        if self.parent == None:
424                                target = self
425                        else:
426                                target = self.parent
427               
428                try:
429                        truncate_csv_timezone = target.configuration.EXPORT_CSV_TRUNCATE_TIMEZONE
430                except:
431                        truncate_csv_timezone = False
432               
433               
434                # NOTE: no need to scrub emulated data
435                try:
436                        scrub_data = target.configuration.EXPORT_CSV_SCRUB_DATA
437                except:
438                        scrub_data = False
439               
440                try:
441                        if self.parent.plugin_eeg.emulate_headset_data:
442                                scrub_data = False
443                except:
444                        pass
445               
446               
447                headers = 'Date,Time'
448               
449               
450                customDataHeaders = []
451                for header in parent.customDataHeaders:
452                        customDataHeaders.append(header)
453                for plugin in parent.activePlugins:
454                        print plugin.name
455                        for header in plugin.customDataHeaders:
456                                customDataHeaders.append(header)
457               
458                for each in customDataHeaders:
459                        headers = headers + ',%s' % each
460               
461                headers = headers + '\n'
462               
463               
464                csv = {}
465               
466                for packet in source.packets['signals']:
467                       
468                       
469                        # NOTE: Move this to ThinkGear Server object
470                        if 'rawEeg' in packet.keys():
471                                continue
472                       
473                       
474                        if packet['timestamp'] not in csv.keys():
475                               
476                                #if 'blinkStrength' in packet.keys():
477                                        ## Skip any blink packets from log
478                                        #continue
479                               
480                               
481                                timestamp = packet['timestamp']
482                                #(date, localtime) = self.parseTimeStamp(timestamp, \
483                                                    #truncate_time_zone=truncate_csv_timezone)
484                                (date, localtime) = source.parseTimeStamp(timestamp, \
485                                                    truncate_time_zone=truncate_csv_timezone)
486                               
487                                csv[timestamp] = {}
488                                csv[timestamp]['Date'] = date
489                                csv[timestamp]['Time'] = localtime
490                               
491                               
492                                for plugin in parent.activePlugins:
493                                        if plugin.customDataHeaders != []:
494                                                try:
495                                                        csv[timestamp] = plugin.processPacketForExport(output=csv[timestamp], packet=packet)
496                                                except Exception, e:
497                                                        if self.DEBUG:
498                                                                print "ERROR: [Synapse:Session] Exception calling processPacketForExport on",
499                                                                print plugin.name
500                       
501                       
502                        for header in customDataHeaders:
503                               
504                                #if header in packet.keys():
505                                        #csv[timestamp][header] = packet[header]
506                               
507                                if 'custom' in packet.keys() and \
508                                   header in packet['custom'].keys():
509                                        csv[timestamp][header] = packet['custom'][header]
510               
511               
512                if scrub_data:
513                        csv = self.scrubData(csv, truncate_csv_timezone, source=source)
514               
515               
516                output = headers
517               
518                timestamps = csv.keys()
519                timestamps.sort()
520               
521                for timestamp in timestamps:
522                       
523                        row = '%s,%s' % \
524                              (csv[timestamp]['Date'], \
525                               csv[timestamp]['Time'])
526                       
527                        for header in customDataHeaders:
528                                row = row + ',%s' % csv[timestamp][header]
529                       
530                        row = row + '\n'
531                       
532                        output = output + row
533               
534               
535                return(output)
536       
537       
538        ##################################################################
539       
540        def scrubData(self, csv, truncate_csv_timezone=False, source=None):
541               
542                # If there are missing packets, repeat a given packet once per missing
543                # second until there is a gap between 1 and 2 seconds, in which case
544                # produce a final duplicate packet at the mid-point between the packets
545               
546                if self.DEBUG:
547                        print "INFO: Scrubbing Data"
548               
549                if source == None:
550                        if self.parent == None:
551                                source = self
552                        else:
553                                source = self.parent
554               
555                last_time = None
556                last_recorded_time = None
557               
558                output = {}
559               
560                csv_keys = csv.keys()
561                csv_keys.sort()
562               
563                for key in csv_keys:
564                       
565                        timestamp = key
566                       
567                        if last_time == None:
568                                # First entry in log
569                                last_time = timestamp
570                                last_recorded_time = timestamp
571                                #output[key] = csv[key]
572                                if key not in output.keys():
573                                        output[key] = DEFAULT_PACKET.copy()
574                                output[key].update(csv[key])
575                                continue
576                       
577                        else:
578                               
579                                #time_difference = timestamp - last_time
580                                #time_difference = timestamp - last_recorded_time
581                                time_difference = abs(timestamp - last_recorded_time)
582                               
583                                if (time_difference <= 1) and \
584                                   (time_difference >= PACKET_MINIMUM_TIME_DIFFERENCE_THRESHOLD):
585                                        # Skip packets within the correct time threshold
586                                        last_time = timestamp
587                                        last_recorded_time = timestamp
588                                        #output[key] = csv[key]
589                                        if key not in output.keys():
590                                                output[key] = DEFAULT_PACKET.copy()
591                                        output[key].update(csv[key])
592                                       
593                                        #print "<=1 and >=min"
594                                        continue
595                               
596                                else:
597                                       
598                                        if self.DEBUG > 1:
599                                                print "time_difference:",
600                                                print time_difference
601                                                print "timestamp:",
602                                                print source.parseTimeStamp(timestamp)[-1].split(' ')[0]
603                                                print "last_time:",
604                                                print source.parseTimeStamp(last_time)[-1].split(' ')[0]
605                                                print "last_recorded_time:",
606                                                print source.parseTimeStamp(last_recorded_time)[-1].split(' ')[0]
607                                       
608                                       
609                                        #new_packet = csv[key].copy()
610                                        if key not in output.keys():
611                                                new_packet = DEFAULT_PACKET.copy()
612                                        new_packet.update(csv[key])
613                                       
614                                        if time_difference >= 2:
615                                               
616                                                ##new_time = last_time + 1
617                                                #new_time = last_recorded_time + 1
618                                               
619                                                count = int(time_difference)
620                                                while count >= 1:
621                                                        #new_packet = csv[key].copy()
622                                                        if key not in output.keys():
623                                                                new_packet = DEFAULT_PACKET.copy()
624                                                        new_packet.update(csv[key])
625                                                       
626                                                        new_time = last_recorded_time + 1
627                                                        (date, formatted_new_time) = source.parseTimeStamp(new_time, \
628                                                         truncate_time_zone=truncate_csv_timezone)
629                                                        new_packet['Time'] = formatted_new_time
630                                                        last_recorded_time = new_time
631                                                        last_time = timestamp
632                                                        if key not in output.keys():
633                                                                output[new_time] = new_packet
634                                                        else:
635                                                                output[new_time].update(new_packet)
636                                                        count = count - 1
637                                                continue
638                                       
639                                                #print ">=2"
640                                       
641                                       
642                                        elif time_difference < PACKET_MINIMUM_TIME_DIFFERENCE_THRESHOLD:
643                                                # Spread out "bunched up" packets
644                                                #new_time = last_time + 1
645                                                new_time = last_recorded_time + 1
646                                                #new_time = last_recorded_time
647                                                #print "<min"
648                                       
649                                       
650                                        elif (time_difference < 2) and (time_difference > 1):
651                                               
652                                                #new_time = last_time + ((last_time - timestamp) / 2)
653                                                #new_time = last_recorded_time + ((last_recorded_time - timestamp) / 2)
654                                                #new_time = last_time + 1
655                                                #new_time = last_recorded_time + 1
656                                                new_time = last_recorded_time
657                                                #print "<2"
658                                       
659                                       
660                                        (date, formatted_new_time) = source.parseTimeStamp(new_time, \
661                                           truncate_time_zone=truncate_csv_timezone)
662                                       
663                                        new_packet['Time'] = formatted_new_time
664                                       
665                                        #last_time = new_time
666                                        last_recorded_time = new_time
667                                        #last_time = timestamp
668                                        last_time = new_time
669                                        try:
670                                                output[new_time].update(new_packet)
671                                        except Exception, e:
672                                                output[new_time] = new_packet
673                                                #print e
674                                       
675                                        if self.DEBUG > 1:
676                                                print "WARN: Scrubbing new packet:",
677                                                print new_packet
678                                                print
679               
680               
681                return(output)
682       
683       
684        ##################################################################
685       
686        def resetData(self, source=None):
687               
688                if source == None:
689                        if self.parent == None:
690                                source = self
691                        else:
692                                source = self.parent
693               
694                source.packets['rawEeg'] = []
695                source.packets['signals'] = []
696               
697                if self.synapseServer != None:
698                        self.synapseServer.protocol.resetSessionStartTime()
699                else:
700                        self.resetSessionStartTime()
701               
702                if self.synapseServer != None:
703                        source.synapseServer.protocol.packet_count = 0
704                        source.synapseServer.protocol.bad_packets = 0
705                else:
706                        source.packet_count = 0
707                        source.bad_packets = 0
708               
709                self.updateProfileSessionStatus()
710               
711                try:
712                        source.textEditDebugConsole.setText("")
713                except:
714                        pass
715       
716       
717        #####################################################################
718       
719        def resetSessionStartTime(self, source=None):
720               
721                self.session_start_timestamp = time.time()
722               
723               
724        #####################################################################
725       
726        def convert_seconds_to_datetime(self, duration):
727               
728                duration_hours = duration / (60 * 60)
729                duration_minutes = (duration - (duration_hours * (60 * 60))) / 60
730                duration_seconds = (duration - (duration_hours * (60 * 60)) - (duration_minutes * 60))
731               
732                duration_hours = '%i' % duration_hours
733                if (len(duration_hours) == 1):
734                        duration_hours = "0%s" % duration_hours
735               
736                duration_minutes = '%i' % duration_minutes
737                if (len(duration_minutes) == 1):
738                        duration_minutes = "0%s" % duration_minutes
739               
740                duration_seconds = '%i' % duration_seconds
741                if (len(duration_seconds) == 1):
742                        duration_seconds = "0%s" % duration_seconds
743               
744                datetime = '%s:%s:%s' % (duration_hours, duration_minutes, duration_seconds)
745               
746                return(datetime)
747
Note: See TracBrowser for help on using the repository browser.