Alias: null
Common Name: DrumDetectorEvaluator
Class: org. imirsel. m2k. evaluation. DrumDetectionEvaluator

Overview: This module evaluates a detected set of drum transcriptions.

Detailed Description: This module evaluates drum transcription algorithms based on a tolerance parameter. Input is a null terminated stream of Signal objects with "Onset times" meta-data, "Drum transcription" meta-data and "Drum transcription labels" meta-data, to be used as the ground-truth, and another stream of Signal objects with the same meta-data, to be tested for accuracy. The F-measure of both the onset detection and drum transcription are returned, as well as a confusion matrix for the transcription. 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 drum transcription
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.

Drum Detector Name
Tha name of the drum 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.