DecayUnit< SampleType, InterpTypeCode > Class Template Reference

Exponential decay filter. More...

List of all members.

Static Public Member Functions
static UnitType	ar (UnitType const &input, UnitType const &duration=SampleType(0.2), UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), BlockSize const &preferredBlockSize=BlockSize::noPreference(), SampleRate const &preferredSampleRate=SampleRate::noPreference()) throw ()
	Creates an exponential deacy filter.
static UnitType	kr (UnitType const &input, UnitType const &duration=SampleType(0.2), UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0)) throw ()
	Creates a control rate exponential deacy filter.

---

Detailed Description

template<class SampleType, Interp::TypeCode InterpTypeCode = Interp::Linear>
class DecayUnit< SampleType, InterpTypeCode >

Exponential decay filter.

Useful for creating simple decaying envlopes from impulses.

Factory functions:

• ar (input, duration=0.2, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)
• kr (input duration=0.2, mul=1, add=0)

Inputs:

• input: (unit, multi) the unit to filter
• duration: (unit, multi) The -60dB decay time in seconds
• mul: (unit, multi) the multiplier applied to the output
• add: (unit, multi) the offset aded to the output
• preferredBlockSize: the preferred output block size (for advanced usage, leave on default if unsure)
• preferredSampleRate: the preferred output sample rate (for advanced usage, leave on default if unsure)

---

Member Function Documentation

template<class SampleType , Interp::TypeCode InterpTypeCode = Interp::Linear>

static UnitType DecayUnit< SampleType, InterpTypeCode >::ar	(	UnitType const &	input,
		UnitType const &	duration = SampleType (0.2),
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		BlockSize const &	preferredBlockSize = BlockSize::noPreference(),
		SampleRate const &	preferredSampleRate = SampleRate::noPreference()
	)		throw () [inline, static]

Creates an exponential deacy filter.

Parameters:

input	The input signal to filter.
duration	The -60dB decay time.
mul	An optional multiplier.
add	An optional offset.
preferredBlockSize	(Optional) The preferred block size for the process.
preferredSampleRate	(Optional) The preferred sample rate for the process.

template<class SampleType , Interp::TypeCode InterpTypeCode = Interp::Linear>

static UnitType DecayUnit< SampleType, InterpTypeCode >::kr	(	UnitType const &	input,
		UnitType const &	duration = SampleType (0.2),
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0)
	)		throw () [inline, static]

Creates a control rate exponential deacy filter.

Parameters:

input	The input signal to filter.
duration	The -60dB decay time.
mul	An optional multiplier.
add	An optional offset.

---

The documentation for this class was generated from the following file:

• plonk_FilterShortcuts.h