StateMonitor.h

Go to the documentation of this file.

/* 
* Copyright 2014-2018 Friedemann Zenke
*
* This file is part of Auryn, a simulation package for plastic
* spiking neural networks.
* 
* Auryn is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 
* Auryn is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with Auryn.  If not, see <http://www.gnu.org/licenses/>.
*
* If you are using Auryn or parts of it for your work please cite:
* Zenke, F. and Gerstner, W., 2014. Limits to high-speed simulations 
* of spiking neural networks using general-purpose computers. 
* Front Neuroinform 8, 76. doi: 10.3389/fninf.2014.00076
*/

#ifndef STATEMONITOR_H_
#define STATEMONITOR_H_

#include "auryn_definitions.h"
#include "AurynVector.h"
#include "Monitor.h"
#include "System.h"
#include "Connection.h"
#include <fstream>
#include <iomanip>

namespace auryn {

class StateMonitor : public Monitor
{
protected:
        SpikingGroup * src;

        AurynState * target_variable;

        AurynState lastval;
        AurynState lastder;

        NeuronID nid;

        AurynTime ssize;

        AurynTime t_stop;

        void init(string filename, AurynDouble stepsize);
        
public:
        bool enable_compression;

        StateMonitor(SpikingGroup * source, NeuronID id, string statename, string filename, AurynDouble sampling_interval=auryn_timestep);

        StateMonitor(AurynStateVector * state, NeuronID id, string filename, AurynDouble sampling_interval=auryn_timestep);

        StateMonitor(AurynSynStateVector * state, NeuronID id, string filename, AurynDouble sampling_interval=auryn_timestep);

        StateMonitor(Trace * trace, NeuronID id, string filename, AurynDouble sampling_interval=auryn_timestep);

        void record_for(AurynDouble time=10.0);

        void set_stop_time(AurynDouble time=10.0);

        void set_step_size(int step=1);

        virtual ~StateMonitor();
        void execute();
};

}

#endif /*STATEMONITOR_H_*/