tPeriodDetection

Period detection algorithm from Katja Vetters http://www.katjaas.nl/helmholtz/helmholtz.html. More...

Functions
void	tPeriodDetection_free (tPeriodDetection *const)
	Free a tPeriodDetection from its mempool. More...
float	tPeriodDetection_tick (tPeriodDetection *const, float sample)
float	tPeriodDetection_getPeriod (tPeriodDetection *const)
void	tPeriodDetection_setHopSize (tPeriodDetection *const, int hs)
void	tPeriodDetection_setWindowSize (tPeriodDetection *const, int ws)
void	tPeriodDetection_setFidelityThreshold (tPeriodDetection *const, float threshold)
void	tPeriodDetection_setAlpha (tPeriodDetection *const, float alpha)
void	tPeriodDetection_setTolerance (tPeriodDetection *const, float tolerance)

Detailed Description

Period detection algorithm from Katja Vetters http://www.katjaas.nl/helmholtz/helmholtz.html.

Function Documentation

tPeriodDetection_free()

void tPeriodDetection_free

(

tPeriodDetection * const

)

Free a tPeriodDetection from its mempool.

Parameters

detection

A pointer to the tPeriodDetection to free.

tPeriodDetection_tick()

float tPeriodDetection_tick	(	tPeriodDetection * const	,
		float	sample
	)

Parameters

detection	A pointer to the relevant tPeriodDetection.
input

Returns

tPeriodDetection_getPeriod()

float tPeriodDetection_getPeriod

(

tPeriodDetection * const

)

Parameters

detection

A pointer to the relevant tPeriodDetection.

Returns

The detected period.

tPeriodDetection_setHopSize()

void tPeriodDetection_setHopSize	(	tPeriodDetection * const	,
		int	hs
	)

Parameters

detection	A pointer to the relevant tPeriodDetection.
hopSize

tPeriodDetection_setWindowSize()

void tPeriodDetection_setWindowSize	(	tPeriodDetection * const	,
		int	ws
	)

Parameters

detection	A pointer to the relevant tPeriodDetection.
windowSize

tPeriodDetection_setFidelityThreshold()

void tPeriodDetection_setFidelityThreshold	(	tPeriodDetection * const	,
		float	threshold
	)

Parameters

detection	A pointer to the relevant tPeriodDetection.
threshold

tPeriodDetection_setAlpha()

void tPeriodDetection_setAlpha	(	tPeriodDetection * const	,
		float	alpha
	)

Parameters

detection	A pointer to the relevant tPeriodDetection.
alpha

tPeriodDetection_setTolerance()

void tPeriodDetection_setTolerance	(	tPeriodDetection * const	,
		float	tolerance
	)

Parameters

detection	A pointer to the relevant tPeriodDetection.
tolerance