metdetection.joint

Class JointModel

java.lang.Object

metdetection.generic.MidiModel

metdetection.joint.JointModel

public class JointModel
extends MidiModel

A JointModel is used to model and infer one of each type of model simultaneously as a set, one step at a time.

Author:

Andrew McLeod - 8 Sept, 2015

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.TreeSet<JointModelState>	hypothesisStates The hypothesis states at the current stage.

Constructor Summary

Constructors

Constructor and Description
JointModel(VoiceSplittingModelState voice, BeatTrackingModelState beat, MetricalModelState hierarchy) Create a new JointModel based on a state with the given constituent states.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This method is called to tell the given model that the input has finished and to flush out all of its states.
java.util.List<? extends BeatTrackingModelState>	getBeatHypotheses() Get an ordered List of the BeatTrackingModelStates which are currently the top hypotheses for this joint model.
java.util.List<? extends MetricalModelState>	getHierarchyHypotheses() Get an ordered List of the MetricalModelStates which are currently the top hypotheses for this joint model.
java.util.TreeSet<JointModelState>	getHypotheses() This method returns a TreeSet of the current hypothesis states of this MidiModel.
java.util.List<? extends VoiceSplittingModelState>	getVoiceHypotheses() Get an ordered List of the VoiceSplittingModelStates which are currently the top hypotheses for this joint model.
void	handleIncoming(java.util.List<MidiNote> notes) This method takes as input some List of MidiNotes, and then does some work on the notes, updating its list of hypotheses in the process.

Methods inherited from class metdetection.generic.MidiModel

toString

Methods inherited from class java.lang.Object

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

Field Detail

hypothesisStates

private java.util.TreeSet<JointModelState> hypothesisStates

The hypothesis states at the current stage.

Constructor Detail

JointModel

public JointModel(VoiceSplittingModelState voice,
          BeatTrackingModelState beat,
          MetricalModelState hierarchy)

Create a new JointModel based on a state with the given constituent states.

Parameters:

voice - The voice splitting state to use.

beat - The beat tracking state to use.

hierarchy - The hierarchy detection state to use.

Method Detail

handleIncoming

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

Description copied from class: MidiModel

This method takes as input some List of MidiNotes, and then does some work on the notes, updating its list of hypotheses in the process.

Specified by:

handleIncoming in class MidiModel

Parameters:

notes - A List of the MidiNotes which we want to handle next.

close

public void close()

Description copied from class: MidiModel

This method is called to tell the given model that the input has finished and to flush out all of its states.

Specified by:

close in class MidiModel

getHypotheses

public java.util.TreeSet<JointModelState> getHypotheses()

Description copied from class: MidiModel

This method returns a TreeSet of the current hypothesis states of this MidiModel.

Specified by:

getHypotheses in class MidiModel

Returns:

A TreeSet of the current hypothesis states of this MidiModel, sorted by score.

getVoiceHypotheses

public java.util.List<? extends VoiceSplittingModelState> getVoiceHypotheses()

Get an ordered List of the VoiceSplittingModelStates which are currently the top hypotheses for this joint model. These may not be sorted in order by their own scores, but they are given in order of the underlying JointModelState's scores.

Returns:

An ordered List of the VoiceSplittingModelStates which are currently the top hypotheses for this joint model.

getBeatHypotheses

public java.util.List<? extends BeatTrackingModelState> getBeatHypotheses()

Get an ordered List of the BeatTrackingModelStates which are currently the top hypotheses for this joint model. These may not be sorted in order by their own scores, but they are given in order of the underlying JointModelState's scores.

Returns:

An ordered List of the BeatTrackingModelStates which are currently the top hypotheses for this joint model.

getHierarchyHypotheses

public java.util.List<? extends MetricalModelState> getHierarchyHypotheses()

Get an ordered List of the MetricalModelStates which are currently the top hypotheses for this joint model. These may not be sorted in order by their own scores, but they are given in order of the underlying JointModelState's scores.

Returns:

An ordered List of the MetricalModelStates which are currently the top hypotheses for this joint model.