Package com.tagtraum.audiokern.key

Class Triad

java.lang.Object

com.tagtraum.audiokern.key.Triad

All Implemented Interfaces:

Chord

public class Triad
extends Object
implements Chord

Triad.

Author:

Hendrik Schreiber

Nested Class Summary

Nested classes/interfaces inherited from interface com.tagtraum.audiokern.key.Chord

Chord.Type

Constructor Summary

Constructors

Constructor	Description
Triad(Tone[] tones)
Triad(Tone root, Chord.Type type)
Triad(Tone t1, Tone t2, Tone t3)

Method Summary

Modifier and Type	Method	Description
boolean	canBeFormedFrom(Tone[] tones, int length)	Indicates whether an array of tones contains all the necessary tones to form this triad.
boolean	contains(Tone tone)
boolean	equals(Object o)
static Triad	getCorrelatingChord(float[] chromagram, Tone baseTone)	Computes the triad with the highest correlation to the given chromagram.
float	getCorrelation(float[] chromagram, Tone chromagramBase)	Computes the correlation of this chord (and type) to a chromagram with the given base tone.
Tone	getRoot()
Tone[]	getTones()
Chord.Type	getType()
int	hashCode()
String	toString()
static Triad[]	values()	All possible triads.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Triad

public Triad(Tone root,
             Chord.Type type)

Triad

public Triad(Tone[] tones)

Triad

public Triad(Tone t1,
             Tone t2,
             Tone t3)

Method Detail

values

public static Triad[] values()

All possible triads.

Returns:

triads

getTones

public Tone[] getTones()

Specified by:

getTones in interface Chord

getRoot

public Tone getRoot()

Specified by:

getRoot in interface Chord

getType

public Chord.Type getType()

Specified by:

getType in interface Chord

getCorrelation

public float getCorrelation(float[] chromagram,
                            Tone chromagramBase)

Description copied from interface: Chord

Computes the correlation of this chord (and type) to a chromagram with the given base tone.

Specified by:

getCorrelation in interface Chord

Parameters:

chromagram - chromagram

Returns:

correlation coefficient

getCorrelatingChord

public static Triad getCorrelatingChord(float[] chromagram,
                                        Tone baseTone)

Computes the triad with the highest correlation to the given chromagram.

Parameters:

chromagram - chromagram

baseTone - base tone of the chromagram

Returns:

triad with the highest correlation coefficient

canBeFormedFrom

public boolean canBeFormedFrom(Tone[] tones,
                               int length)

Indicates whether an array of tones contains all the necessary tones to form this triad. The array may contain more than necessary tones.

Specified by:

canBeFormedFrom in interface Chord

Parameters:

tones - tones

length - number of tones of the given tone array to take into account

Returns:

true, if this triad can be formed from the given array of tones

contains

public boolean contains(Tone tone)

Specified by:

contains in interface Chord

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object