Alias: null
Common Name: MelodyTranscriptionEvaluator
Class: org. imirsel. m2k. evaluation. MelodyTranscriptionEvaluator

Overview: This module evaluates melody transcription algorithms based on a tolerance parameter. Description Input is a null terminated stream of Signal objects with a "Predominent f0" column, to be used as the ground-truth, and another stream of Signal objects with an "Predominent f0" meta-data to be tested for accuracy. The F-measure of the melody transcriber 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 the predominent melody 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 the predominent melody in the audio file listed in the Signal objects "fileLocation" metadata.

Outputs:
Properties:
Evaluation Tolerance (proportion of a semitone)
The tolerance used to matched notated f0 estimates with f0 estimates.

Melody transcriber Name
Tha name of the melody transcriber 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.