Auryn simulator  v0.8.1-206-gb56e451
Plastic Spiking Neural Network Simulator
BurstRateMonitor.h
Go to the documentation of this file.
1 /*
2 * Copyright 2014-2018 Friedemann Zenke
3 *
4 * This file is part of Auryn, a simulation package for plastic
5 * spiking neural networks.
6 *
7 * Auryn is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * Auryn is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with Auryn. If not, see <http://www.gnu.org/licenses/>.
19 *
20 * If you are using Auryn or parts of it for your work please cite:
21 * Zenke, F. and Gerstner, W., 2014. Limits to high-speed simulations
22 * of spiking neural networks using general-purpose computers.
23 * Front Neuroinform 8, 76. doi: 10.3389/fninf.2014.00076
24 */
25 
26 #ifndef BURSTRATEMONITOR_H_
27 #define BURSTRATEMONITOR_H_
28 
29 #include "auryn_definitions.h"
30 #include "AurynVector.h"
31 #include "Monitor.h"
32 #include "System.h"
33 #include "SpikingGroup.h"
34 #include <fstream>
35 #include <iomanip>
36 
37 namespace auryn {
38 
46 class BurstRateMonitor : protected Monitor
47 {
48 private:
50  NeuronID event_counter;
52  NeuronID burst_counter;
54  AurynTime ssize;
56  AurynDouble scaleconst;
58  Trace * post_trace;
60  AurynState thr;
61 
62 protected:
65 
67  void init(SpikingGroup * source, string filename, AurynDouble binsize);
68 
69  virtual void virtual_serialize(boost::archive::binary_oarchive & ar, const unsigned int version );
70  virtual void virtual_serialize(boost::archive::binary_iarchive & ar, const unsigned int version );
71 public:
74 
79  BurstRateMonitor(SpikingGroup * source, string filename="", AurynDouble binsize=0.1);
80 
81 
83  virtual ~BurstRateMonitor();
84 
86  void set_tau(double tau);
87 
89  void execute();
90 };
91 
92 }
93 
94 #endif /*BURSTRATEMONITOR_H_*/
Abstract base class for all Monitor objects.
Definition: Monitor.h:47
void set_tau(double tau)
Sets burst detector time constant.
Definition: BurstRateMonitor.cpp:64
Abstract base class of all objects producing spikes.
Definition: SpikingGroup.h:67
double AurynDouble
Higher precision floating point datatype.
Definition: auryn_definitions.h:158
Abstract base class of synaptic traces.
Definition: Trace.h:36
AurynStateVector * burst_state
Burst state.
Definition: BurstRateMonitor.h:73
void init()
Standard initializer to be called by the constructor.
Definition: Device.cpp:32
void execute()
Implementation of necessary execute() function.
Definition: BurstRateMonitor.cpp:69
Definition: ABSConnection.h:38
AurynFloat AurynState
Type for Auryn state variables (default single precision since it needs to be compatible with auryn_v...
Definition: auryn_definitions.h:160
virtual ~BurstRateMonitor()
Default Destructor.
Definition: BurstRateMonitor.cpp:60
virtual void virtual_serialize(boost::archive::binary_oarchive &ar, const unsigned int version)
Definition: BurstRateMonitor.cpp:109
Monitor class to record population firing rates.
Definition: BurstRateMonitor.h:46
SpikingGroup * src
The source SpikingGroup.
Definition: BurstRateMonitor.h:64
BurstRateMonitor(SpikingGroup *source, string filename="", AurynDouble binsize=0.1)
Default Constructor.
Definition: BurstRateMonitor.cpp:30
Default AurynVectorFloat class for performance computation.
Definition: AurynVector.h:796
NeuronID AurynTime
Defines Auryns discrete time unit of the System clock. Change to AurynLong if 120h of simtime are not...
Definition: auryn_definitions.h:155
unsigned int NeuronID
NeuronID is an unsigned integeger type used to index neurons in Auryn.
Definition: auryn_definitions.h:151