Class ResultSongTSEditDistanceTool

source code

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

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 = ['songcomparets', 'songcompts']

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

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

tool_options = Tool.tool_options+ [ModuleOption('local', filte...

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:

('songcomparets <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  using t
he tonal 
space edit distance metric and outputs the alignment distance.

See also:
    songcomparedep: to compare a result to a song in terms of dependen
cy 
        recovery.
...

tool_options

Value:

Tool.tool_options+ [ModuleOption('local', filter= str_to_bool, usage= 
"local=B, where B is true or false", default= False, help_text= "Use l
ocal alignment to score the similarity " "of the tonal space paths ins
tead of global"), ModuleOption('song', filter= str_to_bool, usage= "to
song=B, where B is true or false", default= False, help_text= "Compare
 the numbered song in the corpus to the " "second song, instead of com
paring the numbered result " "to the song"), ModuleOption('alignment',
 filter= str_to_bool, usage= "alignment=B, where B is true or false", 
...