Package com.tagtraum.beatunes.matchtable

Class SimilarityMatcher

java.lang.Object

com.tagtraum.beatunes.matchtable.SimilarityMatcher

public class SimilarityMatcher
extends Object

Finds similar songs in a set of given songs according to ScoreRules.

Author:

Hendrik Schreiber

See Also:

RuleBasedPrefilter

Constructor Summary

Constructors

Constructor	Description
SimilarityMatcher()	SimilarityMatcher.
SimilarityMatcher(float threshold)	SimilarityMatcher.

Method Summary

Modifier and Type	Method	Description
List<AudioSong>	findMatchingSongs(Iterable<AudioSong> sourceSongs, Float syncBPM, boolean playMatchesAtSyncTempo, Collection<ScoreRule> scoreRules, AudioSong... templates)	Finds songs in sourceSongs that best match the templates according to the provided rules.
float	getThreshold()
void	setThreshold(float threshold)
List<AudioSong>	sort(AudioSong seed, Iterable<AudioSong> sourceList, Float syncBPM, boolean playMatchesAtSyncTempo, Collection<ScoreRule> ruleSet)	Sorts songs in chunks of x songs and then concatenates the chunks in a sorted manner.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimilarityMatcher

public SimilarityMatcher()

SimilarityMatcher.

SimilarityMatcher

public SimilarityMatcher(float threshold)

SimilarityMatcher.

Parameters:

threshold - threshold

Method Detail

getThreshold

public float getThreshold()

setThreshold

public void setThreshold(float threshold)

findMatchingSongs

public List<AudioSong> findMatchingSongs(Iterable<AudioSong> sourceSongs,
                                         Float syncBPM,
                                         boolean playMatchesAtSyncTempo,
                                         Collection<ScoreRule> scoreRules,
                                         AudioSong... templates)

Finds songs in sourceSongs that best match the templates according to the provided rules.

Parameters:

sourceSongs - collection of song to search in

syncBPM - sync bpm

playMatchesAtSyncTempo - matched songs are meant to be played at the same tempo as the template song

scoreRules - rules that govern the matching process

templates - template songs to find matching songs for in order of decreasing importance

Returns:

list of matching song, starting with the best match

sort

public List<AudioSong> sort(AudioSong seed,
                            Iterable<AudioSong> sourceList,
                            Float syncBPM,
                            boolean playMatchesAtSyncTempo,
                            Collection<ScoreRule> ruleSet)

Sorts songs in chunks of x songs and then concatenates the chunks in a sorted manner.

Parameters:

seed - seed song

sourceList - source list

syncBPM - sync BPM

playMatchesAtSyncTempo - sorted songs are meant to be played at the same tempo as the syncBPM

ruleSet - score rules

Returns:

sorted list