NotchUnit< SampleType, InterpTypeCode > Class Template Reference

Notch filter (i.e, parametric mid-EQ). More...

List of all members.

Static Public Member Functions
static UnitType	ar (UnitType const &input, UnitType const &frequency=SampleType(1200), UnitType const &q=SampleType(1), UnitType const &gain=SampleType(0), UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0), BlockSize const &preferredBlockSize=BlockSize::noPreference(), SampleRate const &preferredSampleRate=SampleRate::noPreference()) throw ()
	Create a notch filter.
static UnitType	kr (UnitType const &input, UnitType const &frequency=SampleType(1200), UnitType const &q=SampleType(1), UnitType const &gain=SampleType(0), UnitType const &mul=SampleType(1), UnitType const &add=SampleType(0)) throw ()
	Create a control rate notch filter.

---

Detailed Description

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

Notch filter (i.e, parametric mid-EQ).

Factory functions:

• ar (input, frequency=1200, q=1, gain=0, mul=1, add=0, preferredBlockSize=default, preferredSampleRate=default)
• kr (input frequency=1200, q=1, gain=0, mul=1, add=0)

Inputs:

• input: (unit, multi) the unit to filter
• frequency: (unit, multi) the -3dB point cut-off frequency in Hz
• q: (unit, multi) the filter Q factor
• gain: (unit, multi) the cut/boost in gain dB
• 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 NotchUnit< SampleType, InterpTypeCode >::ar	(	UnitType const &	input,
		UnitType const &	frequency = SampleType (1200),
		UnitType const &	q = SampleType (1),
		UnitType const &	gain = SampleType (0),
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0),
		BlockSize const &	preferredBlockSize = BlockSize::noPreference(),
		SampleRate const &	preferredSampleRate = SampleRate::noPreference()
	)		throw () [inline, static]

Create a notch filter.

Parameters:

input	The input signal to filter.
frequency	The centre frequency.
q	The Q factor.
gain	The boost/cut gain in dB.
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 NotchUnit< SampleType, InterpTypeCode >::kr	(	UnitType const &	input,
		UnitType const &	frequency = SampleType (1200),
		UnitType const &	q = SampleType (1),
		UnitType const &	gain = SampleType (0),
		UnitType const &	mul = SampleType (1),
		UnitType const &	add = SampleType (0)
	)		throw () [inline, static]

Create a control rate notch filter.

Parameters:

input	The input signal to filter.
frequency	The centre frequency.
q	The Q factor.
gain	The boost/cut gain in dB.
mul	An optional multiplier.
add	An optional offset.

---

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

• plonk_FilterShortcuts.h