Package jazzparser :: Package formalisms :: Package music_halfspan :: Module songtools :: Class LoadCorpusTool

Class LoadCorpusTool

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

Tool to load a corpus of tonal space analyses of songs. These may then be used for song recognition. This must be called before other song recognition tools will work.

A corpus may be created from the chord corpus using the bin/data/parsegs.py to parse the chord corpus and store the analyses in a file.

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 = 'Load analysis set'
hash(x)

commands = ['loadsongs']

usage = ('loadsongs <name>', 'load the named tonal space analy...

help = 'Loads a tonal space analysis corpus by name. This corp...

Inherited from shell.tools.Tool: tool_options

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:

('loadsongs <name>', 'load the named tonal space analysis corpus')

help

Value:

'''Loads a tonal space analysis corpus by name. This corpus may then b
e used by 
other tools which require a song corpus.

These corpora are built using the script bin/data/parsegs.py.
'''