.. _generatorsRealDoc:

.. index:: single: Generators

=====================
Real Generator Blocks
=====================

* `Counter ()`_
* `ImpulseTrain ()`_
* `Oscillator ()`_
* `PulseTrain ()`_
* `Random ()`_
* `UnitStep ()`_

----

.. index:: single: Counter()
.. index:: single: Generators; Counter
.. _Counter_RG:


Counter ()
==========

A counter generator. The counter is incremented at the stream rate at discrete steps.

The first output of the counter is ``startValue``

If a switch is connected to ``start`` and it has not been triggered yet, the output of the counter is the ``startValue``.

When the next sample of the counter exceeds the ``rollValue`` the counter is reset and the counter output is ``startValue``

::

	Counter (
		startValue:	1
		rollValue: 	none
		increment: 	1
		start:		none
		stop:		none
		reset:		off
	)
	
:startValue:
	The starting value of the counter which is also the first output of the counter.

:stopValue:
	The roll value of the counter. The maximum value before reseting to ``startValue``
	
:increment:
	The increment value of the counter.
	
:start:
	If a switch is connected to to the ``start`` port, the counter starts when the switch transitions from ``off`` to ``on``.
	
:stop:	
	If a switch is connected to to the ``start`` port, the counter stops when the switch transitions from ``off`` to ``on``.

:reset:
	The counter could be reset to its initial state through a switch connected to the ``reset`` port. The counter is reset when the switch transitions from ``off`` to ``on``.

----

.. index:: single: ImpulseTrain()
.. index:: single: Generators; ImpulseTrain
.. _ImpulseTrain_RG:


ImpulseTrain ()
===============

Impulse train generator.

Unipolar output [ 0. , 1. ] scaled by ``amplitude``

::

	ImpulseTrain (
		amplitude: 	1.0
		frequency: 	0.0
		count:		none
		start:		none
		stop:		none
		reset:		off
	)
	
:amplitude:
	The amplitude of the generator.

:frequency:
	The frequency of the generator.

:count:
	The total number of impulses. If set to ``none`` the total number is infinite.

:start:
	If a switch is connected to to the ``start`` port, the counter starts when the switch transitions from ``off`` to ``on``.
	
:stop:	
	If a switch is connected to to the ``start`` port, the counter stops when the switch transitions from ``off`` to ``on``.

:reset:
	The counter could be reset to its initial state through a switch connected to the ``reset`` port. The counter is reset when the switch transitions from ``off`` to ``on``.
	
----

.. index:: single: Oscillator()
.. index:: single: Generators; Oscillator
.. _Oscillator_RG:

Oscillator ()
=============

Bipolar output [ -1. , 1. ] scaled by ``amplitude``

::

	Oscillator (
		type:		'Sine'
		amplitude:	1.0
		frequency:	0.0
		phase:		0.0
		reset:		off
	}
	
:type:
	Possible options are ``'Sine'``, ``'Triangle'``, ``'Saw'``, ``'ReverseSaw'``, ``'Square'``.

:amplitude:
	The amplitude of the oscillator.

:frequency:
	The frequency of the oscillator.
	
:phase:
	The starting phase of the oscillator.

:reset:
	Resets the oscillator to the starting phase.

	
For a sawtooth oscillator the output is [ -1. , 1.[

For a reverse sawtooth oscillator the output is ] -1., 1] 
	
----

.. index:: single: PulseTrain()
.. index:: single: Generators; PulseTrain
.. _pulseTrain_RG:

PulseTrain ()
=============

Pulse train generator.

Unipolar output [ 0. , 1. ] scaled by ``amplitude``

::

	PulseTrain (
		dutyCycle: 	0.5
		amplitude: 	1.0
		frequency: 	0.0
		phase: 		0.0
		count:		none
		start:		none
		stop:		none
		reset:		off
	)

:amplitude:
	The amplitude of the generator.

:frequency:
	The frequency of the generator.
	
:phase:
	The starting phase of the generator.

:count:
	The total number of impulses. If set to ``none`` the total number is infinite.
	
:start:
	If a switch is connected to to the ``start`` port, the counter starts when the switch transitions from ``off`` to ``on``.
	
:stop:	
	If a switch is connected to to the ``start`` port, the counter stops when the switch transitions from ``off`` to ``on``.

:reset:
	The counter could be reset to its initial state through a switch connected to the ``reset`` port. The counter is reset when the switch transitions from ``off`` to ``on``.
	
----

.. index:: single: Random()
.. index:: single: Generators; Random
.. _Random_RG:

Random ()
=========

::

	Random (
		type:		'Uniform'
		minimum:	-1.0
		maximum:	1.0
		seed:		none
	)

:type:	
	Possible options are ``'Uniform'``, ``'Normal'``, ``'Exponential'``.
	
:minimum:
	The minimum value of the output.

:maximum:
	The maximum value of the output.
	
:seed:	TO BE DEFINED

----

.. index:: single: UnitStep()
.. index:: single: Generators; UnitStep
.. _unitStep_RG:

UnitStep ()
===========

::

	UnitStep (
		sampleDelay:	0
		reset:	off
	)

:sampleDelay:	Delay the unit step by number of samples.