auryn::PoissonStimulator Class Reference

Stimulator class to inject timeseries of currents NeuronGroups. More...

#include <PoissonStimulator.h>

Inheritance diagram for auryn::PoissonStimulator:

Collaboration diagram for auryn::PoissonStimulator:

Public Member Functions
	PoissonStimulator (NeuronGroup *target, AurynFloat rate=100.0, AurynWeight w=0.1)
	Default Constructor. More...
virtual	~PoissonStimulator ()
	Default Destructor. More...
void	set_rate (AurynFloat rate)
	Sets the event rate of the underlying Poisson generator. More...
AurynFloat	get_rate ()
	Returns the event rate of the underlying Poisson generator. More...
void	seed (int s)
	Seeds the random number generator of all PoissonStimulator objects on this rank. More...
void	set_target_state (string state_name="mem")
	Sets the state that is stimulated. More...
void	execute ()
	Implementation of necessary execute() function. More...

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 NeuronGroups.

Instances of this class inject independent currents from a Poisson distribution to the NeuronGroup assigned.

Constructor & Destructor Documentation

PoissonStimulator()

PoissonStimulator::PoissonStimulator	(	NeuronGroup *	target,
		AurynFloat	rate = 100.0,
		AurynWeight	w = 0.1
	)

Default Constructor.

Parameters

                                                                                          : Device( )
{
        init(target,rate,w);
}

Here is the call graph for this function:

~PoissonStimulator()

PoissonStimulator::~PoissonStimulator ( )

virtual

Default Destructor.

{
        free();
}

Member Function Documentation

execute()

void PoissonStimulator::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 ) {
                        int draw = (*die)();
                        target_vector->data[i] += draw*poisson_weight; 
                }
        }
}

Here is the call graph for this function:

get_rate()

AurynFloat PoissonStimulator::get_rate

(

)

Returns the event rate of the underlying Poisson generator.

                                       {
        return poisson_rate;
}

seed()

void PoissonStimulator::seed

(

int

s

)

Seeds the random number generator of all PoissonStimulator objects on this rank.

Parameters

{
                gen.seed(s); 
}

set_rate()

void PoissonStimulator::set_rate

(

AurynFloat

rate

)

Sets the event rate of the underlying Poisson generator.

Parameters

                                                {
        delete dist;
        poisson_rate = rate;
        dist = new boost::poisson_distribution<int> (get_lambda());
}

set_target_state()

void PoissonStimulator::set_target_state

(

std::string

state_name = "mem"

)

Sets the state that is stimulated.

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::PoissonStimulator::dst

protected

The target NeuronGroup

---

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

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