PopulationRateMonitor class

(Shortest import: from brian2 import PopulationRateMonitor)

class brian2.monitors.ratemonitor.PopulationRateMonitor(source, name='ratemonitor*', codeobj_class=None)[source]

Bases: brian2.groups.group.Group, brian2.groups.group.CodeRunner

Record instantaneous firing rates, averaged across neurons from a NeuronGroup or other spike source.

Parameters:

source : (NeuronGroup, SpikeSource)

The source of spikes to record.

name : str, optional

A unique name for the object, otherwise will use source.name+'_ratemonitor_0', etc.

codeobj_class : class, optional

The CodeObject class to run code with.

Notes

Currently, this monitor can only monitor the instantaneous firing rates at each time step of the source clock. Any binning/smoothing of the firing rates has to be done manually afterwards.

Attributes

source The group we are recording from

Methods

reinit() Clears all recorded rates
resize(new_size)

Details

source

The group we are recording from

reinit()[source]

Clears all recorded rates

resize(new_size)[source]

Tutorials and examples using this