metdetection.meter.lpcfg

Class MetricalLpcfgMetricalModelState

java.lang.Object

metdetection.generic.MidiModelState

metdetection.meter.MetricalModelState

metdetection.meter.lpcfg.MetricalLpcfgMetricalModelState

All Implemented Interfaces:

java.lang.Comparable<MetricalLpcfgMetricalModelState>

public class MetricalLpcfgMetricalModelState
extends MetricalModelState
implements java.lang.Comparable<MetricalLpcfgMetricalModelState>

A GrammarHierarchyModelState is used to generate hierarchy hypotheses using a grammar.

Author:

Andrew McLeod - 29 February, 2016

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricalLpcfgMetricalModelState.MetricalLpcfgMatch A MetricalLpcfgMatch is an enum indicating which type of match a MetricalLpcfgMetricalModelState has matched.

Field Summary

Fields

Modifier and Type	Field and Description
private int	anacrusisLength The length of the anacrusis in this state, measured in quantums.
private int	beatMatches The number of times a beat match has been found.
private MetricalLpcfg	grammar The grammar object we will use for probabilities.
private java.util.List<java.lang.Boolean>	hasBegun A List of whether each given voice has begun yet.
private MetricalLpcfg	localGrammar The local grammar for this hierarchy model state.
private double	logProbability The log probability of this hypothesis.
private Measure	measure The measure type we are looking for.
private int	measureNum The measure number of the next subbeat to be shifted onto the stack.
private int	nextMeasureIndex The index of the first beat of the next measure.
private java.util.Queue<MidiNote>	notesToCheck Notes which we have yet to check for beat and sub beat matches.
private java.util.List<java.util.LinkedList<MidiNote>>	notesToCheckBeats A List of a Queue per voice of notes to check for beat matching.
private int	subBeatLength The length of the terminals which we are looking for.
private int	subBeatMatches The number of times a sub beat match has been found.
private java.util.List<java.util.LinkedList<MidiNote>>	unfinishedNotes A List of any notes which have not yet been completely added to a Tree, divided by voice.
private int	wrongMatches The number of times a mismatch has been found.

Fields inherited from class metdetection.meter.MetricalModelState

beatState, voiceState

Constructor Summary

Constructors

Modifier	Constructor and Description
	MetricalLpcfgMetricalModelState(MetricalLpcfg grammar) Create a new state based on the given grammar.
private	MetricalLpcfgMetricalModelState(MetricalLpcfgMetricalModelState state) Create a new state which is a deep copy of the given one (when necessary).
private	MetricalLpcfgMetricalModelState(MetricalLpcfgMetricalModelState state, MetricalLpcfg grammar, Measure measure, int terminalLength, int anacrusisLength) Create a new state based on the given grammar, measure, and terminal length, and as a partial deep copy of the given state.

Method Summary

Methods

Modifier and Type	Method and Description
private void	addMatch(MetricalLpcfgMetricalModelState.MetricalLpcfgMatch matchType) Add the given matchType to this model.
private void	addNewVoices(java.util.List<MidiNote> notes) Add new voices into our tracking list unfinishedNotes.
private boolean	allNotesFinished() Check if all of the voices within unfinishedNotes are empty.
private boolean	checkConglomerateBeatMatch(java.util.LinkedList<MidiNote> voiceNotes) Check for a conglomerate beat match.
java.util.TreeSet<MetricalLpcfgMetricalModelState>	close() Return a TreeSet of all of the possible MidiModelStates which we could tansition into when the input closes.
int	compareTo(MetricalLpcfgMetricalModelState o)
MetricalLpcfgMetricalModelState	deepCopy() Create a deep copy of this HierarchyModelState.
private java.util.List<MetricalLpcfgMetricalModelState>	getAllFirstStepBranches() Get a List of all of the first step branches we could make out of this state.
int	getAnacrusisLength() Get the anacrusis length of this model.
MetricalLpcfg	getLocalGrammar() Get the local grammar of this model.
Measure	getMetricalMeasure() Gets the Measure which is contained by this state currently.
double	getScore() Get the score of this MidiModelState.
int	getSubBeatLength() Get the terminal length of this model.
private int	getTactusNormalized(int tactiPerMeasure, Beat firstBeat, int measure, int tactus) Get the tactus number as a beat index given some information about the Beats.
java.util.TreeSet<MetricalLpcfgMetricalModelState>	handleIncoming(java.util.List<MidiNote> notes) Return a TreeSet of all of the possible MidiModelStates which we could tansition into given the List of MidiNotes.
private boolean	isFullyMatched() Return whether this model has been fully matched yet.
private boolean	isWrong() Return whether this model has been designated as wrong yet.
private boolean	matches(MetricalLpcfgMetricalModelState.MetricalLpcfgMatch matchType) Check if this model matches the given match type.
private void	parseStep() Perform a single parse step.
private void	removeFinishedNotes() Remove any notes which are entirely finished from unfinishedNotes.
java.lang.String	toString()
private void	updateMatchType() Go through the notesToCheck Queue for any notes that have finished and update the current match for any that have.
private void	updateMatchType(int startTactus, int noteLengthTacti) Update the current match for a note with the given start tactus and length.
private void	updateMatchType(MidiNote note) Update the current match type for the given note.

Methods inherited from class metdetection.meter.MetricalModelState

getBeatState, getVoiceState, setBeatState, setVoiceState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

subBeatLength

private final int subBeatLength

The length of the terminals which we are looking for.

anacrusisLength

private final int anacrusisLength

The length of the anacrusis in this state, measured in quantums.

measure

private final Measure measure

The measure type we are looking for.

grammar

private final MetricalLpcfg grammar

The grammar object we will use for probabilities.

localGrammar

private final MetricalLpcfg localGrammar

The local grammar for this hierarchy model state.

logProbability

private double logProbability

The log probability of this hypothesis.

measureNum

private int measureNum

The measure number of the next subbeat to be shifted onto the stack.

nextMeasureIndex

private int nextMeasureIndex

The index of the first beat of the next measure.

hasBegun

private final java.util.List<java.lang.Boolean> hasBegun

A List of whether each given voice has begun yet. This is used to throw out anacrusis measures.

unfinishedNotes

private final java.util.List<java.util.LinkedList<MidiNote>> unfinishedNotes

A List of any notes which have not yet been completely added to a Tree, divided by voice.

notesToCheck

private final java.util.Queue<MidiNote> notesToCheck

Notes which we have yet to check for beat and sub beat matches.

notesToCheckBeats

private final java.util.List<java.util.LinkedList<MidiNote>> notesToCheckBeats

A List of a Queue per voice of notes to check for beat matching.

subBeatMatches

private int subBeatMatches

The number of times a sub beat match has been found.

beatMatches

private int beatMatches

The number of times a beat match has been found.

wrongMatches

private int wrongMatches

The number of times a mismatch has been found.

Constructor Detail

MetricalLpcfgMetricalModelState

public MetricalLpcfgMetricalModelState(MetricalLpcfg grammar)

Create a new state based on the given grammar. The measure and subBeatLength fields will be null and 0 respectively, and appropriate settings for these will be returned by the first call to handleIncoming(List). This allows all possible states to be generated by a single one without having to manually create each one each time.

Parameters:

grammar - grammar

MetricalLpcfgMetricalModelState

private MetricalLpcfgMetricalModelState(MetricalLpcfgMetricalModelState state,
                               MetricalLpcfg grammar,
                               Measure measure,
                               int terminalLength,
                               int anacrusisLength)

Create a new state based on the given grammar, measure, and terminal length, and as a partial deep copy of the given state.

Parameters:

state - The old state we want this new one to be a deep copy of.

grammar - grammar

measure - measure

terminalLength - subBeatLength

anacrusisLength - anacrusisLength

MetricalLpcfgMetricalModelState

private MetricalLpcfgMetricalModelState(MetricalLpcfgMetricalModelState state)

Create a new state which is a deep copy of the given one (when necessary).

Parameters:

state - The state whose deep copy we want.

Method Detail

handleIncoming

public java.util.TreeSet<MetricalLpcfgMetricalModelState> handleIncoming(java.util.List<MidiNote> notes)

Description copied from class: MidiModelState

Return a TreeSet of all of the possible MidiModelStates which we could tansition into given the List of MidiNotes.

Specified by:

handleIncoming in class MetricalModelState

Parameters:

notes - A List of the MidiNotes on which we need to transition.

Returns:

A TreeSet of MidiModelStates which we've transitioned into.

getAllFirstStepBranches

private java.util.List<MetricalLpcfgMetricalModelState> getAllFirstStepBranches()

Get a List of all of the first step branches we could make out of this state. That is, given that we currently do not have a measure, assign all possible measures and terminalLengths to new copies and return them in a List.

Returns:

A List of all possible first step branches out of this state.

close

public java.util.TreeSet<MetricalLpcfgMetricalModelState> close()

Description copied from class: MidiModelState

Return a TreeSet of all of the possible MidiModelStates which we could tansition into when the input closes.

Specified by:

close in class MetricalModelState

Returns:

A TreeSet of the MidiModelStates we've transitioned into.

parseStep

private void parseStep()

Perform a single parse step. That is, make a tree from unfinishedNotes, add it and its probability to our model, and then rmove any finished notes.

allNotesFinished

private boolean allNotesFinished()

Check if all of the voices within unfinishedNotes are empty.

Returns:

True if all of the voices are empty. False otherwise.

removeFinishedNotes

private void removeFinishedNotes()

Remove any notes which are entirely finished from unfinishedNotes.

addNewVoices

private void addNewVoices(java.util.List<MidiNote> notes)

Add new voices into our tracking list unfinishedNotes.

Parameters:

notes - The new notes that were just added.

updateMatchType

private void updateMatchType()

Go through the notesToCheck Queue for any notes that have finished and update the current match for any that have.

checkConglomerateBeatMatch

private boolean checkConglomerateBeatMatch(java.util.LinkedList<MidiNote> voiceNotes)

Check for a conglomerate beat match. That is, a match where some number of notes add up to a beat exactly with no leading, trailing, or interspersed rests.

Parameters:

voiceNotes - The unchecked notes in the voice we want to check.

Returns:

True if we need to continue checking this voice. That is, if this model is not wrong yet, hasn't yet been matched at the beat level, and if we were able to check the beat beginning with the previous first note. False otherwise.

getTactusNormalized

private int getTactusNormalized(int tactiPerMeasure,
                      Beat firstBeat,
                      int measure,
                      int tactus)

Get the tactus number as a beat index given some information about the Beats.

Parameters:

tactiPerMeasure - The number of tacti per measure of the Beats in the Beat List. A value of 0 will return exactly the tactus number that is passed in.

firstBeat - The first Beat of the beat tracker.

measure - The measure number of the beat we want the tactus of.

tactus - The tactus number we want adjusted.

Returns:

The adjusted tactus number.

updateMatchType

private void updateMatchType(MidiNote note)

Update the current match type for the given note.

Parameters:

note - The note we need to check for a match.

updateMatchType

private void updateMatchType(int startTactus,
                   int noteLengthTacti)

Update the current match for a note with the given start tactus and length.

Parameters:

startTactus - The tactus at which this note begins, normalized to where 0 is the beginning of the full anacrusis measure, if any exists.

noteLengthTacti - The length and tacti of the note.

isFullyMatched

private boolean isFullyMatched()

Return whether this model has been fully matched yet. That is, whether it has been matched at both the beat level and the sub beat level.

Returns:

True if this model has been fully matched. False otherwise.

isWrong

private boolean isWrong()

Return whether this model has been designated as wrong yet.

Returns:

True if this model is wrong. False otherwise.

addMatch

private void addMatch(MetricalLpcfgMetricalModelState.MetricalLpcfgMatch matchType)

Add the given matchType to this model.

Parameters:

matchType - The match type we want to add to this model.

matches

private boolean matches(MetricalLpcfgMetricalModelState.MetricalLpcfgMatch matchType)

Check if this model matches the given match type.

Parameters:

matchType - The match type we want to check our model against.

Returns:

True if our model matches the given match type. False otherwise.

getSubBeatLength

public int getSubBeatLength()

Get the terminal length of this model.

Returns:

subBeatLength

getAnacrusisLength

public int getAnacrusisLength()

Get the anacrusis length of this model.

Returns:

anacrusisLength

getLocalGrammar

public MetricalLpcfg getLocalGrammar()

Get the local grammar of this model.

Returns:

localGrammar

getMetricalMeasure

public Measure getMetricalMeasure()

Description copied from class: MetricalModelState

Gets the Measure which is contained by this state currently.

Specified by:

getMetricalMeasure in class MetricalModelState

Returns:

The measure contained by this state.

deepCopy

public MetricalLpcfgMetricalModelState deepCopy()

Description copied from class: MetricalModelState

Create a deep copy of this HierarchyModelState.

Specified by:

deepCopy in class MetricalModelState

Returns:

A deep copy of this HierarchyModelState.

getScore

public double getScore()

Description copied from class: MidiModelState

Get the score of this MidiModelState. In general, a higher score reflects that a State is more likely given our prior knowledge. The natural ordering of MidiModelStates is based on this score value.

Specified by:

getScore in class MidiModelState

Returns:

The score of this MidiModelState.

compareTo

public int compareTo(MetricalLpcfgMetricalModelState o)

Specified by:

compareTo in interface java.lang.Comparable<MetricalLpcfgMetricalModelState>

toString

public java.lang.String toString()

Overrides:

toString in class MetricalModelState