Alias: null
Common Name: OnsetDetectorEvaluator
Class: org. imirsel. m2k. evaluation. OnsetDetectionEvaluator

Overview: This module evaluates a detected set of musical event onset times.

Detailed Description: This module evaluates onset detection algorithms based on a tolerance parameter. Input is a null terminated stream of Signal objects with "Onset times" meta-data, to be used as the ground-truth, and another stream of Signal objects with "Onset times" meta-data to be tested for accuracy. The F-measure of the onset detector is returned. Finally, the serialized Signal arrays and the text result files are copied to a directory, specified as a parameter, for McNemar's testing by another module.

Data Handling: The input data is not modified.
Inputs:
Ground-truth Signal objects
org. imirsel. m2k. util. Signal
A null terminated stream of Signal objects containing Ground-truth transcriptions of event onsets in the audio file listed in the Signal objects "fileLocation" metadata.

Signal objects from onset detection
org. imirsel. m2k. util. Signal
A null terminated stream of Signal objects containing detected transcriptions of event onsets in the audio file listed in the Signal objects "fileLocation" metadata.

Outputs:
Properties:
Evaluation Tolerance
The tolerance used to matched notated onset times with detected onset times.

Onset Detector Name
Tha name of the onset detector under evaluation (Displayed on evaluation output).

Storage directory
The directory to save serialised Signal arrays and text output from the evaluator to.

Verbose
Determines whether filenames and debug info are output to the console.