Skip to content

Commit

Permalink
Updates doxygen strings in RateMonitor
Browse files Browse the repository at this point in the history
  • Loading branch information
Friedemann Zenke committed Apr 3, 2014
1 parent 9c21192 commit 41efd86
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/RateMonitor.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ using namespace std;

/*! \brief Monitor class to record neural firing rates
*
* Instances of this class record the population firing rate of the src SpikingGroup assigned.
* Binning is done discretely in bins of size bsize that is directly transformed in discrete
* AurynTime steps. The default
* Instances of this class record the firing rates of all neurons in the src SpikingGroup.
* To estimate rates online it uses an exponential filter with a time constant that is
* three times the sampling interval. To do so the class uses a synaptic trace. Each rank
* only records spikes from local neurons.
*/

class RateMonitor : protected Monitor
Expand All @@ -61,7 +62,8 @@ class RateMonitor : protected Monitor
/*! Default Constructor
@param[source] The source spiking group.
@param[filename] The filename to write to (should be different for each rank.)
@param[samplinginterval] The sampling interval used for writing data to file.*/
@param[samplinginterval] The sampling interval used for writing data to file.
which currently also determines the filter time constant. */
RateMonitor(SpikingGroup * source, string filename, AurynFloat samplinginterval=1);

/*! Default Destructor */
Expand Down

0 comments on commit 41efd86

Please sign in to comment.