Class ResultSongDependencyRecoveryTool

source code

      object --+    
               |    
shell.tools.Tool --+
                   |
                  ResultSongDependencyRecoveryTool

Instance Methods

[hide private]

run(self, args, state)
Main operation of tool, taking arguments in args and reading and potentially manipulating the shell state.

source code

Inherited from shell.tools.Tool: process_option_list

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

name = 'Compare result'
hash(x)

commands = ['songcomparedep', 'songdep']

usage = ('songcomparedep <result-num> <song-num>', 'compare a ...

help = 'Compares a parse result to a specific song in the data...

tool_options = Tool.tool_options+ [ModuleOption('song', filter...

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

run(self, args, state)

source code

Main operation of tool, taking arguments in args and reading and potentially manipulating the shell state.

By the time this is called, the options dict is available in self.options.

Overrides: shell.tools.Tool.run: (inherited documentation)

Class Variable Details

[hide private]

usage

Value:

('songcomparedep <result-num> <song-num>',
 'compare a parse result to a song in the database using the tonal spa
ce edit distance metric')

help

Value:

'''Compares a parse result to a specific song in the database in terms
 of 
dependency recovery and outputs the recall, precision and f-score.

See also:
    songcomparets: to compare a result to a song in terms of tonal spa
ce path 
        edit distance.
...

tool_options

Value:

Tool.tool_options+ [ModuleOption('song', filter= str_to_bool, usage= "
tosong=B, where B is true or false", default= False, help_text= "Compa
re the numbered song in the corpus to the " "second song, instead of c
omparing the numbered result " "to the song"),]