a periodic SpikeGenerator (constant ISI) creating spikes at a certain rate More...

#include <periodic_spikegen.h>

Inheritance diagram for PeriodicSpikeGenerator:

Public Member Functions
	PeriodicSpikeGenerator (float rate, bool spikeAtZero=true)
	PeriodicSpikeGenerator constructor. More...

	~PeriodicSpikeGenerator ()
	PeriodicSpikeGenerator destructor. More...

int	nextSpikeTime (CARLsim *sim, int grpId, int nid, int currentTime, int lastScheduledSpikeTime, int endOfTimeSlice)
	schedules the next spike time More...

Public Member Functions inherited from SpikeGenerator
virtual	~SpikeGenerator ()

Detailed Description

This class implements a period SpikeGenerator that schedules spikes with a constant inter-spike-interval. For example, a PeriodicSpikeGenerator with rate=10Hz will schedule spikes for each neuron in the group at t=100, t=200, t=300, etc. If spikeAtZero is set to true, then the first spike will be scheduled at t=0.

Definition at line 61 of file periodic_spikegen.h.

Constructor & Destructor Documentation

◆ PeriodicSpikeGenerator()

PeriodicSpikeGenerator	(	float	rate,
		bool	spikeAtZero = `true`
	)

Parameters

[in]	rate	the firing rate (Hz) at which to schedule spikes
[in]	spikeAtZero	a boolean flag to indicate whether to insert the first spike at t=0

Definition at line 56 of file periodic_spikegen.cpp.

◆ ~PeriodicSpikeGenerator()

~PeriodicSpikeGenerator ( )

inline

Definition at line 71 of file periodic_spikegen.h.

Member Function Documentation

◆ nextSpikeTime()

int nextSpikeTime	(	CARLsim *	sim,
		int	grpId,
		int	nid,
		int	currentTime,
		int	lastScheduledSpikeTime,
		int	endOfTimeSlice
	)

virtual

This function schedules the next spike time, given the currentTime and the lastScheduledSpikeTime. It implements the virtual function of the base class.

Parameters

[in]	sim	pointer to a CARLsim object
[in]	grpId	current group ID for which to schedule spikes
[in]	nid	current neuron ID for which to schedule spikes
[in]	currentTime	current time (ms) at which spike scheduler is called
[in]	lastScheduledSpikeTime	the last time (ms) at which a spike was scheduled for this nid, grpId

Returns: the next spike time (ms)

Implements SpikeGenerator.

Definition at line 65 of file periodic_spikegen.cpp.