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