StimulusGroup.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 STIMULUSGROUP_H_

#define STIMULUSGROUP_H_

#include "auryn_definitions.h"
#include "AurynVector.h"
#include "System.h"
#include "SpikingGroup.h"

#include <boost/random/mersenne_twister.hpp>
#include <boost/random/uniform_01.hpp>
#include <boost/random/uniform_real.hpp>
#include <boost/random/uniform_int.hpp>
#include <boost/random/exponential_distribution.hpp>
#include <boost/random/normal_distribution.hpp>
#include <boost/random/variate_generator.hpp>

#define SOFTSTARTTIME 0.1

namespace auryn {


class StimulusGroup : public SpikingGroup
{
private:
        AurynTime * clk;

        std::fstream tiserfile;

        AurynFloat base_rate;

        int off_pattern;



protected:
        AurynTime * ttl;

        AurynFloat * activity;

        StimulusGroupModeType stimulus_order ;


        unsigned int stimulation_count;

        NeuronID fgx;

        NeuronID bgx;

        std::vector<double> probabilities ;

        static boost::mt19937 poisson_gen; 

        static boost::mt19937 order_gen; 
        static boost::uniform_01<boost::mt19937> order_die; 



        AurynTime next_action_time ;

        AurynTime last_action_time ;

        AurynTime last_stim_onset_time ;

        AurynTime last_stim_offset_time ;

        void init(StimulusGroupModeType stimulusmode, string stimfile, AurynFloat baserate);

        virtual void redraw();

        void write_stimulus_file(AurynDouble time);

        void read_next_stimulus_from_file(AurynDouble &time, int &active, int &stimulusid );

        void set_activity( NeuronID i, AurynFloat val=0.0 );

        AurynFloat mean_off_period ;

        AurynFloat mean_on_period ;

        AurynFloat curscale;
        
public:
        int cur_stim_index ;

        bool stimulus_active;


        std::vector<type_pattern> stimuli;

        virtual unsigned int get_num_stimuli();

        AurynFloat scale;

        bool binary_patterns;

        AurynTime refractory_period;

        bool randomintervals;

        bool randomintensities;

        AurynDouble background_rate;

        bool background_during_stimulus;

        StimulusGroup(NeuronID n, string filename, string stimfile, StimulusGroupModeType stimulusmode=RANDOM, AurynFloat baserate=1.0 );

        StimulusGroup(NeuronID n, string stimfile, StimulusGroupModeType stimulusmode=RANDOM, AurynFloat baserate=1.0 );

        virtual ~StimulusGroup();

        virtual void evolve();

        void set_baserate(AurynFloat baserate);
        void set_maxrate(AurynFloat baserate); 

        void set_stimulation_mode(StimulusGroupModeType mode);

        void set_all( AurynFloat val=0.0 );

        void seed( int rndseed );

        AurynFloat get_activity(NeuronID i);

        virtual void load_patterns( string filename );

        virtual void clear_patterns( );

        void set_mean_off_period(AurynFloat period);

        void set_mean_on_period(AurynFloat period);

        void set_pattern_activity( unsigned int i );

        void set_pattern_activity( unsigned int i, AurynFloat setval );

        virtual void set_active_pattern( unsigned int i );

        void set_active_pattern( unsigned int i, AurynFloat default_value);

        void set_next_action_time(double time);

        void set_distribution ( std::vector<double> probs );

        std::vector<double> get_distribution ( );

        double get_distribution ( int i );

        unsigned int get_stim_count();


        AurynTime get_last_action_time();

        AurynTime get_last_onset_time();

        AurynTime get_last_offset_time();

        AurynTime get_next_action_time();

        unsigned int get_cur_stim();

        bool get_stim_active();

        void flat_distribution( );

        void normalize_distribution( );

        std::vector<type_pattern> * get_patterns();

};

}

#endif /*STIMULUSGROUP_H_*/