gid_recorder (tuple or list of tuples, optional (default: None)) – The gids of the recording devices. If None, then all existing
spike_recs are used.
record (tuple or list, optional (default: None)) – List of the monitored variables for each device. If gid_recorder is
None, record can also be None and only spikes are considered.
network (Network
or subclass, optional (default: None)) – Network which activity will be monitored.
gids (tuple, optional (default: None)) – NEST gids of the neurons which should be monitored.
axis (matplotlib axis object, optional (default: new one)) – Axis that should be use to plot the activity. This takes precedence
over fignum.
show (bool, optional (default: False)) – Whether to show the plot right away or to wait for the next plt.show().
histogram (bool, optional (default: False)) – Whether to display the histogram when plotting spikes rasters.
limits (tuple, optional (default: None)) – Time limits of the plot (if not specified, times of first and last
spike for raster plots).
title (str, optional (default: None)) – Title of the plot.
fignum (int, or dict, optional (default: None)) – Plot the activity on an existing figure (from figure.number
). This
parameter is ignored if axis is provided.
label (str or list, optional (default: None)) – Add labels to the plot (one per recorder).
sort (str or list, optional (default: None)) – Sort neurons using a topological property (“in-degree”, “out-degree”,
“total-degree” or “betweenness”), an activity-related property
(“firing_rate” or neuronal property) or a user-defined list of sorted
neuron ids. Sorting is performed by increasing value of the sort
property from bottom to top inside each group.
normalize (float or list, optional (default: None)) – Normalize the recorded results by a given float. If a list is provided,
there should be one entry per voltmeter or multimeter in the recorders.
If the recording was done through monitor_groups, the population can
be passed to normalize the data by the nuber of nodes in each group.
decimate (int or list of ints, optional (default: None)) – Represent only a fraction of the spiking neurons; only one neuron in
decimate will be represented (e.g. setting decimate to 5 will lead
to only 20% of the neurons being represented). If a list is provided,
it must have one entry per NeuralGroup in the population.
kernel_center (float, optional (default: 0.)) – Temporal shift of the Gaussian kernel, in ms (for the histogram).
kernel_std (float, optional (default: 0.5% of simulation time)) – Characteristic width of the Gaussian kernel (standard deviation) in ms
(for the histogram).
resolution (float or array, optional (default: 0.1*kernel_std)) – The resolution at which the firing rate values will be computed.
Choosing a value smaller than kernel_std is strongly advised.
If resolution is an array, it will be considered as the times were the
firing rate should be computed (for the histogram).
cut_gaussian (float, optional (default: 5.)) – Range over which the Gaussian will be computed (for the histogram).
By default, we consider the 5-sigma range. Decreasing this value will
increase speed at the cost of lower fidelity; increasing it with
increase the fidelity at the cost of speed.
**kwargs (dict) – “color” and “alpha” values can be overriden here.