PYIN Parameters » History » Version 20

« Previous - Version 20/42 (diff) - Next » - Current version
Chris Cannam, 2019-11-18 01:44 PM


PYIN Parameters

Tony uses a Vamp plugin called pYIN for pitch and note analysis.

The plugin can be used in other Vamp plugin hosts as well - see the pYIN project page to download the plugin separately from Tony.

pYIN has a number of processing parameters which can be adjusted, and Tony contains a number of options (on the Analysis menu) which adjust some of them. However, the names, identifiers, and default values of the pYIN parameters do not match those used in Tony. In some cases this is because the parameters found in pYIN are continuous ranges, while the settings in Tony are all on-off toggles.

Here is a table showing the correspondence between Tony menu options and pYIN parameters, as of Tony v2.1 and pYIN v1.1.

Tony menu option pYIN parameter name pYIN parameter id pYIN parameter type Default in Tony Default in pYIN Notes
Unbiased Timing (slow) Use non-standard precise YIN timing (slow) precisetime Toggle Off Off
Penalise Soft Pitches Suppress low amplitude pitch estimates lowampsuppression Range 0.0-1.0 0.2 0.1 Set to 0.0 when option switched off; see comment below
High Onset Sensitivity Onset sensitivity onsetsensitivity Range 0.0-1.0 0.7 0.7 Set to 0.0 when option switched off
Drop Short Notes Duration pruning threshold prunethresh Range 0.0-0.2 0.1 0.1 Set to 0.0 when option switched off

Note: There is a bug in Tony v2.1 (as well as earlier releases) in the handling of the "Penalise Soft Pitches" option. When you first run the application, this option is ticked in the menu, but it is not actually activated when running pYIN (the pYIN parameter is instead set to 0.0). If you switch the option off and on again in the menu, or select "Reset Options to Defaults", then the parameter will subsequently be set correctly. This state is remembered in subsequent runs, so you only have to do this once. The bug will be fixed in Tony v2.1.1. This does unfortunately mean the behaviour of v2.1.1 "out of the box" will differ slightly from the (erroneous) first-run behaviour of v2.1.

There are also some parameters in pYIN that cannot be controlled within Tony:

Screenshots:

Options in the Analysis menu of Tony that control pYIN parameters Options in Tony Analysis menu for controlling pYIN parameters Options available when using pYIN directly in Sonic Visualiser Options in Sonic Visualiser for controlling pYIN parameters

Screenshot_2019-11-18_13-04-25.png - Options in Sonic Visualiser for controlling pYIN parameters 53.4 KB, downloaded 689 times Chris Cannam, 2019-11-18 01:05 PM

Screenshot_2019-11-18_13-03-34.png - Options in Tony Analysis menu for controlling pYIN parameters 19.8 KB, downloaded 659 times Chris Cannam, 2019-11-18 01:05 PM