Agent

java.lang.Object
- be.tarsos.dsp.beatroot.Agent

```
public class Agent
extends java.lang.Object
```
Agent is the central class for beat tracking. Each Agent object has a tempo hypothesis, a history of tracked beats, and a score evaluating the continuity, regularity and salience of its beat track.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`beatCount` The number of beats found by this Agent, including interpolated beats.
`double`	`beatInterval` The current tempo hypothesis of the Agent, expressed as the beat period in seconds.
`double`	`beatTime` The time of the most recent beat accepted by this Agent.
`static double`	`CONF_FACTOR` The slope of the penalty function for onsets which do not coincide precisely with predicted beat times.
`static boolean`	`debug` Print debugging information
`static double`	`DEFAULT_CORRECTION_FACTOR` The reactiveness/inertia balance, i.e.
`static double`	`DEFAULT_EXPIRY_TIME` The default value of expiryTime, which is the time (in seconds) after which an Agent that has no Event matching its beat predictions will be destroyed.
`EventList`	`events` The list of Events (onsets) accepted by this Agent as beats, plus interpolated beats.
`double`	`initialBeatInterval` The initial tempo hypothesis of the Agent, expressed as the beat period in seconds.
`static double`	`INNER_MARGIN` The default value of innerMargin, which is the maximum time (in seconds) that a beat can deviate from the predicted beat time without a fork occurring.
`static double`	`MAX_CHANGE` The maximum allowed deviation from the initial tempo, expressed as a fraction of the initial beat period.
`double`	`phaseScore` Sum of salience values of the Events which have been interpreted as beats by this Agent, weighted by their nearness to the predicted beat times.
`static double`	`POST_MARGIN_FACTOR` The maximum amount by which a beat can be later than the predicted beat time, expressed as a fraction of the beat period.
`double`	`postMargin` The size of the outer half-window after the predicted beat time.
`static double`	`PRE_MARGIN_FACTOR` The maximum amount by which a beat can be earlier than the predicted beat time, expressed as a fraction of the beat period.
`double`	`preMargin` The size of the outer half-window before the predicted beat time.
`double`	`tempoScore` To be used in real-time version??
`double`	`topScoreTime` How long has this agent been the best? For real-time version; otherwise not used.

Constructor Summary

Constructors
Constructor and Description

Agent(Agent clone)
Copy constructor.

Agent(double ibi)
Constructor: the work is performed by init()

Constructors
Constructor and Description
`Agent(Agent clone)` Copy constructor.
`Agent(double ibi)` Constructor: the work is performed by init()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`considerAsBeat(Event e, AgentList a)` The given Event is tested for a possible beat time.
`void`	`fillBeats(double start)` Interpolates missing beats in the Agent's beat track.
`void`	`print()` Output debugging information about this Agent, at the default (highest) level of detail.
`void`	`print(int level)` Output debugging information about this Agent.
`void`	`showTracking(EventList allEvents)` Show detailed debugging output describing the beat tracking behaviour of this agent.
`void`	`showTracking(EventList allEvents, double level)` Show detailed debugging output describing the beat tracking behaviour of this agent.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - debug
```
public static boolean debug
```
    Print debugging information
  - POST_MARGIN_FACTOR
```
public static double POST_MARGIN_FACTOR
```
    The maximum amount by which a beat can be later than the predicted beat time, expressed as a fraction of the beat period.
  - PRE_MARGIN_FACTOR
```
public static double PRE_MARGIN_FACTOR
```
    The maximum amount by which a beat can be earlier than the predicted beat time, expressed as a fraction of the beat period.
  - INNER_MARGIN
```
public static final double INNER_MARGIN
```
    The default value of innerMargin, which is the maximum time (in seconds) that a beat can deviate from the predicted beat time without a fork occurring.
    
    See Also:
    
    Constant Field Values
  - MAX_CHANGE
```
public static double MAX_CHANGE
```
    The maximum allowed deviation from the initial tempo, expressed as a fraction of the initial beat period.
  - CONF_FACTOR
```
public static double CONF_FACTOR
```
    The slope of the penalty function for onsets which do not coincide precisely with predicted beat times.
  - DEFAULT_CORRECTION_FACTOR
```
public static final double DEFAULT_CORRECTION_FACTOR
```
    The reactiveness/inertia balance, i.e. degree of change in the tempo, is controlled by the correctionFactor variable. This constant defines its default value, which currently is not subsequently changed. The beat period is updated by the reciprocal of the correctionFactor multiplied by the difference between the predicted beat time and matching onset.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EXPIRY_TIME
```
public static final double DEFAULT_EXPIRY_TIME
```
    The default value of expiryTime, which is the time (in seconds) after which an Agent that has no Event matching its beat predictions will be destroyed.
    
    See Also:
    
    Constant Field Values
  - preMargin
```
public double preMargin
```
    The size of the outer half-window before the predicted beat time.
  - postMargin
```
public double postMargin
```
    The size of the outer half-window after the predicted beat time.
  - tempoScore
```
public double tempoScore
```
    To be used in real-time version??
  - phaseScore
```
public double phaseScore
```
    Sum of salience values of the Events which have been interpreted as beats by this Agent, weighted by their nearness to the predicted beat times.
  - topScoreTime
```
public double topScoreTime
```
    How long has this agent been the best? For real-time version; otherwise not used.
  - beatCount
```
public int beatCount
```
    The number of beats found by this Agent, including interpolated beats.
  - beatInterval
```
public double beatInterval
```
    The current tempo hypothesis of the Agent, expressed as the beat period in seconds.
  - initialBeatInterval
```
public double initialBeatInterval
```
    The initial tempo hypothesis of the Agent, expressed as the beat period in seconds.
  - beatTime
```
public double beatTime
```
    The time of the most recent beat accepted by this Agent.
  - events
```
public EventList events
```
    The list of Events (onsets) accepted by this Agent as beats, plus interpolated beats.
- Constructor Detail
  - Agent
```
public Agent(double ibi)
```
    Constructor: the work is performed by init()
    
    Parameters:
    
    ibi - The beat period (inter-beat interval) of the Agent's tempo hypothesis.
  - Agent
```
public Agent(Agent clone)
```
    Copy constructor.
    
    Parameters:
    
    clone - The Agent to duplicate.
- Method Detail
  - print
```
public void print()
```
    Output debugging information about this Agent, at the default (highest) level of detail.
  - print
```
public void print(int level)
```
    Output debugging information about this Agent.
    
    Parameters:
    
    level - The level of detail in debugging
  - considerAsBeat
```
public boolean considerAsBeat(Event e,
                              AgentList a)
```
    The given Event is tested for a possible beat time. The following situations can occur: 1) The Agent has no beats yet; the Event is accepted as the first beat. 2) The Event is beyond expiryTime seconds after the Agent's last 'confirming' beat; the Agent is terminated. 3) The Event is within the innerMargin of the beat prediction; it is accepted as a beat. 4) The Event is within the outerMargin's of the beat prediction; it is accepted as a beat by this Agent, and a new Agent is created which doesn't accept it as a beat. 5) The Event is ignored because it is outside the windows around the Agent's predicted beat time.
    
    Parameters:
    
    e - The Event to be tested
    
    a - The list of all agents, which is updated if a new agent is created.
    
    Returns:
    
    Indicate whether the given Event was accepted as a beat by this Agent.
  - fillBeats
```
public void fillBeats(double start)
```
    Interpolates missing beats in the Agent's beat track.
    
    Parameters:
    
    start - Ignore beats earlier than this start time
  - showTracking
```
public void showTracking(EventList allEvents)
```
    Show detailed debugging output describing the beat tracking behaviour of this agent. Calls showTracking()/1 with a default metrical level of 1.
    
    Parameters:
    
    allEvents - An EventList of all onsets
  - showTracking
```
public void showTracking(EventList allEvents,
                         double level)
```
    Show detailed debugging output describing the beat tracking behaviour of this agent.
    
    Parameters:
    
    allEvents - An EventList of all onsets
    
    level - The metrical level of beat tracking relative to the notated beat (used to count beats)

Class Agent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debug

POST_MARGIN_FACTOR

PRE_MARGIN_FACTOR

INNER_MARGIN

MAX_CHANGE

CONF_FACTOR

DEFAULT_CORRECTION_FACTOR

DEFAULT_EXPIRY_TIME

preMargin

postMargin

tempoScore

phaseScore

topScoreTime

beatCount

beatInterval

initialBeatInterval

beatTime

events

Constructor Detail

Agent

Agent

Method Detail

print

print

considerAsBeat

fillBeats

showTracking

showTracking