.. _processorsFilterDoc:

.. index:: single: Filter Processors

=======================
Filter Processor Blocks
=======================

* `BandPass ()`_
* `BandReject ()`_
* `BiQuad ()`_
* `HighPass ()`_
* `HighShelf ()`_
* `LowPass ()`_
* `LowShelf ()`_

----

.. index:: single: BandPass()
.. index:: single: Filter Processors; BandPass
.. _BandPass_FP:

BandPass ()
===========

::

	BandPass (
		bypass:	off
	)

----

.. index:: single: BandReject()
.. index:: single: Filter Processors; BandReject
.. _BandReject_FP:

BandReject ()
=============

::

	BandReject (
		bypass:	off
	)
	
	
----

.. index:: single: BiQuad()
.. index:: single: Filter Processors; BiQuad
.. _biQuad_FP:

BiQuad ()
=========

::

	BiQuad (
		type:			none
		centerFrequency:	0.0
		resonance:		1.0
		reset:			off
		bypass:			off
	)

:type:
	The type of the biQuad filter.
	Possible values are ``'LowPass'``, ``'HighPass'``, ``'BandPass'``, ``'BandPassUnitGain'``, ``'BandReject'``, and ``'AllPass'``.
	
:centerFrequency:
	The center frequency of the filter.

:resonance:	
	Resonance (Q) amount. Should be greater than on equal to 1.0.

:reset:
	Resets the internal memory of the filter when set to ``on``.

----

.. index:: single: HighPass()
.. index:: single: Filter Processors; HighPass
.. _HighPass_FP:

HighPass ()
===========

::

	HighPass (
		cutOff:	0.0
		reset:	off
		bypass:	off
	)


:cutOff:
	Cutoff frequency in Hz.
	
:reset:
	Resets the internal memory of the filter when set to ``on``.

----

.. index:: single: HighShelf()
.. index:: single: Filter Processors; HighShelf
.. _HighShelf:

HighShelf ()
============

::

	HighShelf (
		cutOff:	0.0
		gainDB:	0.0
		reset:	off
		bypass:	off
	)


:cutOff:
	Cutoff frequency in Hz.

:gainDB:
	Gain amount in dB.
	
:reset:
	Resets the internal memory of the filter when set to ``on``.	

----

.. index:: single: LowPass()
.. index:: single: Filter Processors; LowPass
.. _LowPass_FP:

LowPass ()
==========

::

	LowPass (
		cutOff:	0.0
		reset:	off
		bypass:	off
	)


:cutOff:
	Cutoff frequency in Hz.
	
:reset:
	Resets the internal memory of the filter when set to ``on``.

----

.. index:: single: LowShelf()
.. index:: single: Filter Processors; LowShelf
.. _LowShelf_FP:

LowShelf ()
===========

::

	LowShelf (
		cutOff:	0.0
		gainDB:	0.0
		reset:	off
		bypass:	off
	)


:cutOff:
	Cutoff frequency in Hz.

:gainDB:
	Gain amount in dB.
	
:reset:
	Resets the internal memory of the filter when set to ``on``.