sinusoidal_gamma_generator – Generates sinusoidally modulated gamma spike trains
================================================================================

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

``sinusoidal_gamma_generator`` generates sinusoidally modulated gamma spike
trains. By default, each target of the generator will receive a different
spike train.

The instantaneous rate of the process is given by

.. math::

 f(t) = rate + amplitude \sin ( 2 \pi frequency t + phase \cdot \pi/180 )

.. note::

   - The gamma generator requires 0 <= amplitude <= rate.
   - The state of the generator is reset on calibration.
   - The generator does not support precise spike timing.
   - You can use the multimeter to sample the rate of the generator.
   - The generator will create different trains if run at different
     temporal resolutions.

Individual spike trains vs single spike train:
By default, the generator sends a different spike train to each of its
targets. If /individual_spike_trains is set to false using either
SetDefaults or CopyModel before a generator node is created, the generator
will send the same spike train to all of its targets.

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

rate
    Mean firing rate, default: 0 spikes/s

amplitude
    Firing rate modulation amplitude, default: 0 s^-1

frequency
    Modulation frequency, default: 0 Hz

phase
    Modulation phase in degree [0-360], default: 0

order
    Gamma order (>= 1), default: 1

individual_spike_trains
    See note above, default: true

See also [1]_.

Setting 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. frequency
 1. phase
 2. order
 3. rate
 4. amplitude
 5. individual_spike_trains

Receives
++++++++

DataLoggingRequest

Sends
+++++

SpikeEvent

References
++++++++++

.. [1] Barbieri et al. (2001). Construction and analysis of non-Poisson
       stimulus-response models of neural spiking activity. Journal of
       Neuroscience Methods, 105:25-3.
       DOI: https://doi.org/10.1016/S0165-0270(00)00344-7

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