music21.alpha.theoryAnalysis.theoryResult

IntervalTheoryResult

class music21.alpha.theoryAnalysis.theoryResult.IntervalTheoryResult(intv)

IntervalTheoryResult bases

IntervalTheoryResult methods

IntervalTheoryResult.color(color='red', noteList=(1, 2))

Color the notes in the interval as specified by noteList, 1 for the noteStart and 2 for the noteEnd default is to color all notes

IntervalTheoryResult.hasEditorial(miscKey, editorialValue=True)

return True if either the noteStart or the noteEnd has the editorial key .editorial.misc[miscKey] present and equal to a certain editorialValue (True by default)

IntervalTheoryResult.lyric(value, noteList=(2, ))

sets the lyric of the notes as specified by noteList, default is to only label the noteEnd’s lyric

IntervalTheoryResult.offset(leftAlign=False)

returns the calculated offset of the vlq, which is just the largest offset between the first notes in both lines

if leftAlign=True, returns the minimum instead

IntervalTheoryResult instance variables

IntervalTheoryResult.intv

The actual Interval object associated with this theory result object

Instance variables inherited from TheoryResult:

NoteTheoryResult

class music21.alpha.theoryAnalysis.theoryResult.NoteTheoryResult(n)

NoteTheoryResult bases

NoteTheoryResult methods

NoteTheoryResult.color(color='red')

set the color of this note

NoteTheoryResult instance variables

NoteTheoryResult.n

The actual Note object associated with this theory result object

Instance variables inherited from TheoryResult:

TheoryResult

class music21.alpha.theoryAnalysis.theoryResult.TheoryResult

A TheoryResult object is used to store information about the results of the theory analysis. Each object includes a direct references to the original segment in the score, in addition to a textual description of the result found, and a value. Uses subclasses corresponding to the different types of objects

TheoryResult methods

TheoryResult.color(color)

Bass-class method to color the individual elements in the theory result object. Polymorphically colors the theory result objects based on the type of object.

TheoryResult instance variables

TheoryResult.currentColor

The color of the entire theory result object

TheoryResult.text

The text associated with this theory result object, as generated by an identify() function

TheoryResult.value

The value, typically a short string, associated with this theory result object, as generated by an identify() function

ThreeNoteLinearSegmentTheoryResult

class music21.alpha.theoryAnalysis.theoryResult.ThreeNoteLinearSegmentTheoryResult(tnls)

ThreeNoteLinearSegmentTheoryResult bases

ThreeNoteLinearSegmentTheoryResult methods

ThreeNoteLinearSegmentTheoryResult.color(color='red', noteList=(2, ))

color all the notes in noteList (1,2,3). Default is to color only the second note red

ThreeNoteLinearSegmentTheoryResult instance variables

ThreeNoteLinearSegmentTheoryResult.tnls

The actual ThreeNoteLinearSegment object associated with this theory result object

Instance variables inherited from TheoryResult:

VLQTheoryResult

class music21.alpha.theoryAnalysis.theoryResult.VLQTheoryResult(vlq)

VLQTheoryResult bases

VLQTheoryResult methods

VLQTheoryResult.color(color='red', noteList=(1, 2, 3, 4))

Color the notes in the vlq as specified by noteList, which is a list of numbers 1-4 corresponding to the vlq map:

[ 1  2
  3  4  ]

Default is to color all notes

VLQTheoryResult.hasEditorial(miscKey, editorialValue=True)

return True if any of the four VLQTheoryResult notes have the editorial key .editorial.misc[miscKey] present and equal to a certain editorialValue (True by default)

VLQTheoryResult.markNoteEditorial(editorialDictKey, editorialValue, editorialMarkList=(1, 2, 3, 4))

Mark each note as specified in editorialMarkList with the editorialValue in Editorial.misc[editorialDictKey].

editorialMarkList is a list with the notenumber in the voiceleadingquartet to mark.

[ 1  2
  3  4  ]

Default is to mark all four notes with the editorial.

VLQTheoryResult.offset(leftAlign=False)

returns the calculated offset of the vlq, which is just the maximum offset of all the notes inthe vlq

if leftAlign=True, returns the minimum instead

VLQTheoryResult instance variables

VLQTheoryResult.vlq

The actual VoiceLeadingQuartet object associated with this theory result object

Instance variables inherited from TheoryResult:

VerticalityNTupletTheoryResult

class music21.alpha.theoryAnalysis.theoryResult.VerticalityNTupletTheoryResult(vsnt, partNumIdentified=None)

VerticalityNTupletTheoryResult bases

VerticalityNTupletTheoryResult methods

VerticalityNTupletTheoryResult.color(color='red', partNum=None, noteList=None)

color the notes in partNum as specified by noteList (1,2,3, etc.)

VerticalityNTupletTheoryResult.markNoteEditorial(editorialDictKey, editorialValue, editorialMarkDict=None)

editorialMarkDict is a dictionary denoting which object in the verticality Triplet to mark with the editorial object. the keys of the dictionary correspond to which vertical slice (0, 1, 2, etc.) and the editorialValues are a list of the partNums to mark.

Default editorialMarkDict = {2:[1]}

VerticalityNTupletTheoryResult instance variables

VerticalityNTupletTheoryResult.vsnt

The actual VerticalityNTuplet object associated with this theory result object’, ‘partNumIdentified’:’Storate location for the part of importance that can be used later to color the results

Instance variables inherited from TheoryResult:

VerticalityTheoryResult

class music21.alpha.theoryAnalysis.theoryResult.VerticalityTheoryResult(vs)

VerticalityTheoryResult bases

VerticalityTheoryResult methods

VerticalityTheoryResult.color(color='red', partList=None)

color all the notes from parts in partList. Default is to color all notes form all parts

VerticalityTheoryResult instance variables

VerticalityTheoryResult.vs

The actual Verticality object associated with this theory result object

Instance variables inherited from TheoryResult: