.. _processorsConditioningDoc:

.. index:: single: Signal Conditioning Processors

====================================
Signal Conditioning Processor Blocks
====================================

* `Clip ()`_
* `Compare ()`_
* `FixedDelay ()`_
* `Invert ()`_
* `Level ()`_
* `Map ()`_
* `Mix ()`_
* `OnChange ()`_
* `Pan ()`_
* `Rectify ()`_
* `Round ()`_

----

.. index:: single: Compare()
.. index:: single: Signal Conditioning Processors; Compare
.. _Compare_SCP:

Compare ()
==========

Converts signal block streams to switch streams

::

	Compare ( 
		value:		0.0
		operator:	'Greater'
	)

:value:

	The value to compare against.

:operator:
	
	``'Equal'``: equal
	
	``'NotEqual'``: not equal

	``'Greater'``: greater than
	
	``'Less'``: less than
	
	``'GreaterOrEqual'``: greater than or equal 
	
	``'LessOrEqual'``: less than or equal

----

.. index:: single: Clip()
.. index:: single: Signal Conditioning Processors; Clip
.. _Clip_SCP:

Clip ()
=======

::

	Clip (
		minimum:	0.0
		maximum:	1.0
		bypass:		off
	)

:minimum:

:maximum:

----

.. index:: single: FixedDelay()
.. index:: single: Signal Conditioning Processors; FixedDelay
.. _FixedDelay_SCP:

FixedDelay ()
=============

::

	FixedDelay (
		samples:	1
		default:	0.0
		reset:		off
		bypass:		off
	)

:samples:
	Delay amount in sample counts.

:default:
	The initialization value of the delay buffer.
	
:reset:
	Resets the internal memory of the filter when set to ``on``.

----

.. index:: single: Invert()
.. index:: single: Signal Conditioning Processors; Invert
.. _Invert_SCP:

Invert ()
=========

Inverts the input.

::

	Invert (
		bypass:		off
	)
	
----

.. index:: single: Level()
.. index:: single: Signal Conditioning Processors; Level
.. _Level_SCP:

Level ()
========

Scales the input signal and applies an offset to it.

output = input * gain + offset 

If all properties are integers the input port is a SIP else it is a SRP. 

::

	Level (
		gainType:	'Linear'
		gain: 		1.0
		offset: 		0.0	
		bypass:		off
	)

:gainType:
	Sets the gain type to linear or decibel scaling. 
	Possible values are ``'Linear'`` and ``'Decibel'``.

:gain:
	Amplifies or attenuates the signal.	
	
:offset:
	Adds an offset to the signal after applying the gain.


----

.. index:: single: Map()
.. index:: single: Signal Conditioning Processors; Map
.. _Map_SCP:

Map ()
======

The input of Map is a Stream Real Port.

::

	Map (
		mode:		'Linear'
		minimum:	0.0
		maximum:	1.0
		bypass:		off
	)

:mode:
	Possible values are ``'Linear'`` and ``'Exponential'``.
:minimum:

:maximum:

----

.. index:: single: Mix()
.. index:: single: Signal Conditioning Processors; Mix
.. _Mix_SCP:

Mix ()
======

Sums the signals connected to its input port(s) and then applies a gain and an offset to the sum.

::

	Mix (
		gainType:	'Linear'
		gain:		1.0
		offset:		0.0
		bypass:		off
	)


:gainType:
	Sets the gain type to linear or decibel scaling. 
	Possible values are ``'Linear'`` and ``'Decibel'``.

:gain:
	Amplifies or attenuates the signal before mixing.	
	
:offset:
	Adds an offset to the signal after applying the gain before mixing.

----

.. index:: single: OnChange()
.. index:: single: Signal Conditioning Processors; OnChange
.. _OnChange_SCP:

OnChange ()
===========

Only sends a value out if current input is different from previous input.

::

	OnChange (
		bypass:		off
	)

----

.. index:: single: Pan()
.. index:: single: Signal Conditioning Processors; Pan
.. _Pan_SCP:

Pan ()
======

Mono to stereo processing.

::

	Pan (
		position:	0.0
		bypass:		off
	)
	
:position:
	The panning position. Values should be between [-1.0, 1.0]
	
----

.. index:: single: Rectify()
.. index:: single: Signal Conditioning Processors; Rectify
.. _Rectify_SCP:

Rectify ()
==========

Performs full or half rectification of signal.

::

	Rectify (
		mode:	'Full'
		bypass:	off
	)
	
:mode:
	Possible options are ``'Full'`` and ``'Half'``.

----

.. index:: single: Round()
.. index:: single: Signal Conditioning Processors; Round
.. _Round_SCP:

Round ()
========

Performs full or half rectification of signal.

::

	Round (
		mode:		'Truncate'
		increment:	1.0
		bypass:		off
	)
	
:mode:
	Possible options are ``'Truncate'``, ``'Floor'``, and ``'Ceiling'``.
	
:increment:
	The increment or reduction to round to.