giuliomoro@0: #!/usr/bin/python
giuliomoro@0: 
giuliomoro@0: import xml.etree.ElementTree as ET
giuliomoro@0: import os # list files in directory
giuliomoro@0: import sys # command line arguments
giuliomoro@0: import matplotlib.pyplot as plt # plots
giuliomoro@0: import matplotlib.patches as patches # rectangles
giuliomoro@0: 
giuliomoro@0: # COMMAND LINE ARGUMENTS
giuliomoro@0: 
giuliomoro@0: assert len(sys.argv)<3, "timeline_view takes at most 1 command line argument\n"+\
giuliomoro@0:                         "Use: python timeline_view.py [XML_files_location]"
giuliomoro@0: 
giuliomoro@0: # XML results files location
giuliomoro@0: if len(sys.argv) == 1:
giuliomoro@0:     folder_name = "../saves"    # Looks in 'saves/' folder from 'scripts/' folder
giuliomoro@0:     print "Use: python timeline_view.py [XML_files_location]"
giuliomoro@0:     print "Using default path: " + folder_name
giuliomoro@0: elif len(sys.argv) == 2:
giuliomoro@0:     folder_name = sys.argv[1]   # First command line argument is folder
giuliomoro@0: 
giuliomoro@0: # check if folder_name exists
giuliomoro@0: if not os.path.exists(folder_name):
giuliomoro@0:     #the file is not there
giuliomoro@0:     print "Folder '"+folder_name+"' does not exist."
giuliomoro@0:     sys.exit() # terminate script execution
giuliomoro@0: elif not os.access(os.path.dirname(folder_name), os.W_OK):
giuliomoro@0:     #the file does exist but write privileges are not given
giuliomoro@0:     print "No write privileges in folder '"+folder_name+"'."
giuliomoro@0: 
giuliomoro@0: 
giuliomoro@0: # CONFIGURATION 
giuliomoro@0: 
giuliomoro@0: # Folder where to store timelines
giuliomoro@0: timeline_folder = folder_name + '/timelines/'    # Stores in 'saves/timelines/'
giuliomoro@0: 
giuliomoro@0: # Font settings
giuliomoro@0: font = {'weight' : 'bold',
giuliomoro@0:         'size'   : 16}
giuliomoro@0: plt.rc('font', **font)
giuliomoro@0: 
giuliomoro@0: # Colormap for to cycle through
giuliomoro@0: colormap = ['b', 'r', 'g', 'c', 'm', 'y', 'k']
giuliomoro@0: 
giuliomoro@0: # if enabled, x-axis shows time per audioholder, not total test time
giuliomoro@0: show_audioholder_time = True
giuliomoro@0: 
giuliomoro@0: # bar height (<1 to avoid overlapping)
giuliomoro@0: bar_height = 0.6
giuliomoro@0: 
giuliomoro@0: # figure size
giuliomoro@0: fig_width = 25
giuliomoro@0: fig_height = 5
giuliomoro@0: 
giuliomoro@0: 
giuliomoro@0: # CODE
giuliomoro@0: 
giuliomoro@0: # create timeline_folder if not yet created
giuliomoro@0: if not os.path.exists(timeline_folder):
giuliomoro@0:     os.makedirs(timeline_folder)
giuliomoro@0: 
giuliomoro@0: # get every XML file in folder
giuliomoro@0: for file in os.listdir(folder_name):
giuliomoro@0:     if file.endswith(".xml"):
giuliomoro@0:         tree = ET.parse(folder_name + '/' + file)
giuliomoro@0:         root = tree.getroot()
giuliomoro@0:         subject_id = file[:-4] # drop '.xml'
giuliomoro@0:         
giuliomoro@0:         time_offset = 0 # test starts at zero
giuliomoro@0:         
giuliomoro@0:         # ONE TIMELINE PER PAGE - make new plot per page
giuliomoro@0: 
giuliomoro@0:         # get list of all page names
giuliomoro@0:         for audioholder in root.findall("./audioholder"):   # iterate over pages
giuliomoro@0:             page_name = audioholder.get('id')               # get page name
giuliomoro@0:             plot_empty = True                               # check if any data is plotted
giuliomoro@0:             
giuliomoro@0:             if page_name is None: # ignore 'empty' audio_holders
giuliomoro@0:                 break
giuliomoro@0: 
giuliomoro@0:             # SORT AUDIO ELEMENTS ALPHABETICALLY
giuliomoro@0:             audioelements = audioholder.findall("./audioelement")
giuliomoro@0:             
giuliomoro@0:             data = []
giuliomoro@0:             for elem in audioelements: # from http://effbot.org/zone/element-sort.htm
giuliomoro@0:                 key = elem.get("id")
giuliomoro@0:                 data.append((key, elem))
giuliomoro@0:             data.sort()
giuliomoro@0:             
giuliomoro@0:             N_audioelements = len(audioelements) # number of audio elements for this page
giuliomoro@0:             increment = 0 # increased for every new audioelement
giuliomoro@0:             audioelements_names = [] # store names of audioelements
giuliomoro@0:             
giuliomoro@0:             # get axes handle
giuliomoro@0:             fig = plt.figure(figsize=(fig_width, fig_height))
giuliomoro@0:             ax  = fig.add_subplot(111) #, aspect='equal'
giuliomoro@0:             
giuliomoro@0:             # for page [page_name], print comments related to fragment [id]
giuliomoro@0:             for tuple in data:
giuliomoro@0:                 audioelement = tuple[1]
giuliomoro@0:                 if audioelement is not None: # Check it exists
giuliomoro@0:                     audio_id = str(audioelement.get('id'))
giuliomoro@0:                     audioelements_names.append(audio_id)
giuliomoro@0:                     
giuliomoro@0:                     # for this audioelement, loop over all listen events
giuliomoro@0:                     listen_events = audioelement.findall("./metric/metricresult/[@name='elementListenTracker']/event")
giuliomoro@0:                     for event in listen_events:
giuliomoro@0:                         # mark this plot as not empty
giuliomoro@0:                         plot_empty = False
giuliomoro@0:                     
giuliomoro@0:                         # get testtime: start and stop
giuliomoro@0:                         start_time = float(event.find('testtime').get('start'))-time_offset
giuliomoro@0:                         stop_time  = float(event.find('testtime').get('stop'))-time_offset
giuliomoro@0:                         # event lines:
giuliomoro@0:                         ax.plot([start_time, start_time], # x-values
giuliomoro@0:                             [0, N_audioelements+1], # y-values
giuliomoro@0:                             color='k'
giuliomoro@0:                             )
giuliomoro@0:                         ax.plot([stop_time, stop_time], # x-values
giuliomoro@0:                             [0, N_audioelements+1], # y-values
giuliomoro@0:                             color='k'
giuliomoro@0:                             )
giuliomoro@0:                         # plot time: 
giuliomoro@0:                         ax.add_patch(
giuliomoro@0:                             patches.Rectangle(
giuliomoro@0:                                 (start_time, N_audioelements-increment-bar_height/2), # (x, y)
giuliomoro@0:                                 stop_time - start_time, # width
giuliomoro@0:                                 bar_height, # height
giuliomoro@0:                                 color=colormap[increment%len(colormap)] # colour
giuliomoro@0:                             )
giuliomoro@0:                         )
giuliomoro@0:                         
giuliomoro@0:                 increment+=1 # to next audioelement
giuliomoro@0:                 
giuliomoro@0:             # subtract total audioholder length from subsequent audioholder event times
giuliomoro@0:             audioholder_time = audioholder.find("./metric/metricresult/[@id='testTime']")
giuliomoro@0:             if audioholder_time is not None and show_audioholder_time: 
giuliomoro@0:                 time_offset = float(audioholder_time.text)
giuliomoro@0:             
giuliomoro@0:             if not plot_empty:
giuliomoro@0:                 # set plot parameters
giuliomoro@0:                 plt.title('Timeline ' + file + ": "+page_name)
giuliomoro@0:                 plt.xlabel('Time [seconds]')
giuliomoro@0:                 plt.ylabel('Fragment')
giuliomoro@0:                 plt.ylim(0, N_audioelements+1)
giuliomoro@0:             
giuliomoro@0:                 #y-ticks: fragment IDs, top to bottom
giuliomoro@0:                 plt.yticks(range(N_audioelements, 0, -1), audioelements_names) # show fragment names
giuliomoro@0: 
giuliomoro@0: 
giuliomoro@0:                 #plt.show() # uncomment to show plot; comment when just saving
giuliomoro@0:                 #exit()
giuliomoro@0:             
giuliomoro@0:                 plt.savefig(timeline_folder+subject_id+"-"+page_name+".pdf", bbox_inches='tight')
giuliomoro@0:                 plt.close()
giuliomoro@0:             
giuliomoro@0:             #TODO: if 'nonsensical' or unknown: dashed line until next event
giuliomoro@0:             #TODO: Vertical lines for fragment looping point
giuliomoro@0: