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