ppd_sup_generator – Simulate the superimposed spike train of a population of Poisson processes with dead time
=============================================================================================================

Description
+++++++++++

The ``ppd_sup_generator`` generator simulates the pooled spike train of a
population of neurons firing independently with Poisson process with dead
time statistics.
The rate parameter can also be sine-modulated. The generator does not
initialize to equilibrium in this case, initial transients might occur.

.. include:: ../models/stimulation_device.rst

rate
    Mean firing rate of the component processes, default: 0 spikes/s

dead_time
    Minimal time between two spikes of the component processes, default: 0 ms

n_proc
    Number of superimposed independent component processes, default: 1

frequency
    Rate modulation frequency, default: 0 Hz

relative_amplitude
    Relative rate modulation amplitude, default: 0

See also [1]_.

Set parameters from a stimulation backend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The parameters in this stimulation device can be updated with input
coming from a stimulation backend. The data structure used for the
update holds one value for each of the parameters mentioned above.
The indexing is as follows:

 0. dead_time
 1. rate
 2. n_proc
 3. frequency
 4. relative_amplitude

References
++++++++++

.. [1]  Deger M, Helias M, Boucsein C, Rotter S (2011). Statistical properties
        of superimposed stationary spike trains. Journal of Computational
        Neuroscience. DOI: https://doi.org/10.1007/s10827-011-0362-8

See also
++++++++
:doc:`Device <index_device>`, :doc:`Generator <index_generator>`