auryn::NormalStimulator Class Reference

Stimulator class to inject timeseries of currents to patterns (subpopulations) of neurons. More...

#include <NormalStimulator.h>

Inheritance diagram for auryn::NormalStimulator:

Collaboration diagram for auryn::NormalStimulator:

Public Member Functions
	NormalStimulator (NeuronGroup *target, AurynWeight sigma=1.0, string target_state="inj_current")
virtual	~NormalStimulator ()
void	set_sigma (AurynFloat sigma)
AurynFloat	get_sigma ()
void	seed (int s)
void	set_target_state (string state_name="inj_current")
void	execute ()

Protected Attributes
NeuronGroup *	dst
Protected Attributes inherited from auryn::Device
std::string	device_name
	Identifying name for device. More...
bool	active
	Standard active switch. More...

Additional Inherited Members
Protected Member Functions inherited from auryn::Device
void	init ()
	Standard initializer to be called by the constructor. More...
virtual void	virtual_serialize (boost::archive::binary_oarchive &ar, const unsigned int version)
virtual void	virtual_serialize (boost::archive::binary_iarchive &ar, const unsigned int version)
	Device ()
	Standard constructor. More...
void	set_name (std::string s)
	Set device name. More...
std::string	get_name ()
	Get device name. More...
int	get_id ()
	Get numeric device id. More...
virtual void	flush ()
	Flush to file. More...
virtual	~Device ()
	Standard destructor. More...
virtual void	evolve ()

Detailed Description

Stimulator class to inject timeseries of currents to patterns (subpopulations) of neurons.

Instances of this class inject currents that vary over time to subpopulations of the NeuronGroup assigned.

Constructor & Destructor Documentation

NormalStimulator()

NormalStimulator::NormalStimulator	(	NeuronGroup *	target,
		AurynWeight	sigma = 1.0,
		std::string	target_state = "inj_current"
	)

Default Constructor

Parameters

                                                                                                   : Device( )
{
        init(target, sigma, target_state);
}

Here is the call graph for this function:

~NormalStimulator()

NormalStimulator::~NormalStimulator ( )

virtual

Default Destructor

{
        free();
}

Member Function Documentation

execute()

void NormalStimulator::execute ( )

virtual

Implementation of necessary execute() function.

Reimplemented from auryn::Device.

{
        if ( dst->evolve_locally() ) {
                for ( NeuronID i = 0 ; i < dst->get_post_size() ; ++i ) {
                        float draw = (*die)();
                        target_vector->data[i] = draw; 
                }
        }
}

Here is the call graph for this function:

get_sigma()

AurynFloat NormalStimulator::get_sigma

(

)

Returns the event rate of the underlying Normal generator

                                       {
        return (AurynFloat) normal_sigma;
}

seed()

void NormalStimulator::seed

(

int

s

)

Seeds the random number generator of all NormalStimulator objects

{
                gen.seed(s); 
}

set_sigma()

void NormalStimulator::set_sigma

(

AurynFloat

sigma

)

Sets the event rate of the underlying Normal generator

                                                  {
        delete dist;
        normal_sigma = sigma;
        dist = new boost::normal_distribution<float> (0.0, get_lambda());
}

set_target_state()

void NormalStimulator::set_target_state

(

std::string

state_name = "inj_current"

)

Sets the state that is stimulated with Normal input. This must be a valid state vector name (default = mem)

                                                            {
        target_vector = dst->get_state_vector(state_name);
}

Here is the call graph for this function:

Member Data Documentation

dst

NeuronGroup* auryn::NormalStimulator::dst

protected

The target NeuronGroup

---

The documentation for this class was generated from the following files:

• /home/zenke/auryn/src/auryn/NormalStimulator.h
• /home/zenke/auryn/src/auryn/NormalStimulator.cpp