tPowerFollower

Measure and follow the power of an input signal using an exponential moving average for smoothing. More...

Functions
void	tPowerFollower_init (tPowerFollower *const, float factor, LEAF *const leaf)
	Initialize a tPowerFollower to the default mempool of a LEAF instance. More...
void	tPowerFollower_initToPool (tPowerFollower *const, float factor, tMempool *const)
	Initialize a tPowerFollower to a specified mempool. More...
void	tPowerFollower_free (tPowerFollower *const)
	Free a tPowerFollower from its mempool. More...
float	tPowerFollower_tick (tPowerFollower *const, float input)
	Pass a sample into the power follower and return the current power. More...
float	tPowerFollower_getPower (tPowerFollower *const)
	Get the current power. More...
void	tPowerFollower_setFactor (tPowerFollower *const, float factor)
	Set the smoothing factor for the moving average. More...

Detailed Description

Measure and follow the power of an input signal using an exponential moving average for smoothing.

Function Documentation

tPowerFollower_init()

void tPowerFollower_init	(	tPowerFollower * const	,
		float	factor,
		LEAF *const	leaf
	)

Initialize a tPowerFollower to the default mempool of a LEAF instance.

Parameters

follower	A pointer to the tPowerFollower to initialize.
factor	Smoothing factor of the moving average. 0.0-1.0, with a higher value discounting older inputs more quickly.
leaf	A pointer to the leaf instance.

tPowerFollower_initToPool()

void tPowerFollower_initToPool	(	tPowerFollower * const	,
		float	factor,
		tMempool * const
	)

Initialize a tPowerFollower to a specified mempool.

Parameters

follower	A pointer to the tPowerFollower to initialize.
factor	Smoothing factor of the moving average. 0.0-1.0, with a higher value discounting older inputs more quickly.
mempool	A pointer to the tMempool to use.

tPowerFollower_free()

void tPowerFollower_free

(

tPowerFollower * const

)

Free a tPowerFollower from its mempool.

Parameters

follower

A pointer to the tPowerFollower to free.

tPowerFollower_tick()

float tPowerFollower_tick	(	tPowerFollower * const	,
		float	input
	)

Pass a sample into the power follower and return the current power.

Parameters

follower	A pointer to the relevant tPowerFollower.
input	The input sample

Returns

The current power.

tPowerFollower_getPower()

float tPowerFollower_getPower

(

tPowerFollower * const

)

Get the current power.

Parameters

follower

A pointer to the relevant tPowerFollower.

Returns

The current power.

tPowerFollower_setFactor()

int tPowerFollower_setFactor	(	tPowerFollower * const	,
		float	factor
	)

Set the smoothing factor for the moving average.

Parameters

follower	A pointer to the relevant tPowerFollower.
factor	Smoothing factor of the moving average. 0.0-1.0, with a higher value discounting older inputs more quickly.