diff README.txt @ 10:507300d2ed66 tip

merge

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Thu Oct 10 09:18:47 2013 +0100
@@ -0,0 +1,36 @@
+Metrics Files for D-CASE Challenge
+http://c4dm.eecs.qmul.ac.uk/sceneseventschallenge/
+
+Copyright (c) 2013 Dimitrios Giannoulis, Emmanouil Benetos, Dan Stowell, Mark Plumbley and Queen Mary University of London
+
+- for licence information see the file named COPYING.
+
+For details on metric definitions, please see the following Technical Report: http://c4dm.eecs.qmul.ac.uk/sceneseventschallenge/EECSRR-13-01.pdf
+
+====
+
+1. Scene Classification Metrics
+
+[confusionMat, AccFolds, Acc, Std] = sceneClassificationMetrics_eval(numfolds, foldsGTlist, foldstestlist)
+
+The function sceneClassificationMetrics_eval takes as input a number of folds (numfolds, e.g. 5), a file containing a list of ground-truth files which correspond to each fold (foldsGTlist - an example is given in foldGTlist.txt), and a file containing the list of folds in the scene classification system (foldstestlist). An example on the format of the foldstestlist file is given in foldtestlist.txt. Likewise, the internal structure of a fold file is givein in fold1_test_ubhjwk.txt. 
+
+For instructions on formatting the output files for the scene classification system, please see: http://c4dm.eecs.qmul.ac.uk/sceneseventschallenge/aasp_scenerec_spec.pdf. 
+
+The output of the metrics function contains the confusion matrix (confusionMat), the accuracy per fold (AccFolds), the overall accuracy (Acc), and the standard deviation (Std).
+
+===
+
+2. Event Detection Metrics
+
+In each case, 'outputFile' is a text file containing a list of detected events from the event detection system (see http://c4dm.eecs.qmul.ac.uk/sceneseventschallenge/aasp_eventdet_OL_spec.pdf for formatting guidelines). 'GTFile' is the corresponding list of ground-truth events, formatted in the same way. 
+
+a. Frame-based metrics: [results] = eventDetectionMetrics_frameBased(outputFile,GTFile)
+
+b. Event-based metrics: [results] = eventDetectionMetrics_eventBased(outputFile,GTFile)
+
+c. Class-wise event-based metrics: [results] = eventDetectionMetrics_classWiseEventBased(outputFile,GTFile)
+
+In all cases, 'results' is a structure containing the corresponding metrics. For the frame-wise case, results contain Precision (Pre), Recall (Rec), F-Measure (F), and the AEER metric (AEER).
+
+