File: reference-monitors.txt

package info (click to toggle)
brian 1.4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, stretch
  • size: 23,436 kB
  • sloc: python: 68,707; cpp: 29,040; ansic: 5,182; sh: 111; makefile: 61
file content (36 lines) | stat: -rw-r--r-- 1,412 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
.. currentmodule:: brian

Monitors
--------

Monitors are used to record properties of your network. The two
most important are :class:`SpikeMonitor` which records spikes, and
:class:`StateMonitor` which records values of state variables. These
objects are just added to the network like a :class:`NeuronGroup` or
:class:`Connection`.

Implementation note: monitors that record spikes are classes
derived from :class:`Connection`, and overwrite the ``propagate`` method
to store spikes. If you want to write your own custom spike
monitors, you can do the same (or just use :class:`SpikeMonitor` with
a custom function). Monitors that record values are classes
derived from :class:`NetworkOperation` and implement the ``__call__``
method to store values each time the network updates. Custom
state monitors are most easily written by just writing your
own network operation using the ``network_operation``
decorator.

.. autoclass:: SpikeMonitor
.. autoclass:: SpikeCounter
.. autoclass:: PopulationSpikeCounter
.. autoclass:: StateSpikeMonitor
.. autoclass:: StateMonitor
.. autoclass:: MultiStateMonitor
.. autoclass:: RecentStateMonitor
.. autoclass:: AERSpikeMonitor
.. autoclass:: FileSpikeMonitor
.. autoclass:: ISIHistogramMonitor
.. autoclass:: PopulationRateMonitor
.. autoclass:: VanRossumMetric
.. autoclass:: CoincidenceCounter
.. autoclass:: StateHistogramMonitor