Schedules¶
Generate sorted time points.
- class arbor.schedule¶
Opaque representation of a schedule.
- regular_schedule(t0, dt, t1 = None);
Regular schedule with start
t0, intervaldt, and optional endt1.
- regular_schedule(dt);
Regular schedule with interval
dt.
- explicit_schedule(seq);
Generate events from a predefined sorted event sequence.
- explicit_schedule_from_milliseconds(seq);
Generate events from a predefined sorted event sequence given in units of
[ms]
- poisson_schedule(tstart, rate, seed=None, tstop=None);
Poisson point process with rate
rate. The underlying Mersenne Twister pRNG is seeded withseed
- schedule poisson_schedule(rate, seed=None, tstop=None);
Poisson point process with rate
rate. The underlying Mersenne Twister pRNG is seeded withseed
Event Generators¶
Wrapper class around schedules to generate spikes based on the internal schedule with a given target and weight.
- class arbor.event_generator¶
- __init___(target, weight, schedule)¶
Construct an event generator for a
targetsynapse withweightof the events to deliver based on a schedule (i.e.,arbor.regular_schedule,arbor.explicit_schedule,arbor.poisson_schedule).
- target¶
The target synapse of type
arbor.cell_local_label.
- weight¶
The weight delivered to the target synapse. It is up to the target mechanism to interpret this quantity. For Arbor-supplied point processes, such as the
expsynsynapse, a weight of1corresponds to an increase in conductivity in the target mechanism of1μS (micro-Siemens).
- class arbor.regular_schedule¶
Describes a regular schedule with multiples of
dtwithin the interval [tstart,tstop).- regular_schedule(tstart, dt, tstop)¶
Construct a regular schedule as list of times from
tstarttotstopindttime steps.By default returns a schedule with
tstart=tstop=Noneanddt= 0 ms.
- tstart¶
The delivery time of the first event in the sequence [ms]. Must be non-negative or
None.
- dt¶
The interval between time points [ms]. Must be non-negative.
- tstop¶
No events will be delivered after this time [ms]. Must be non-negative or
None.
- events(t0, t1)¶
Returns a view of monotonically increasing time values in the half-open interval [t0, t1).
- class arbor.explicit_schedule¶
Describes an explicit schedule at a predetermined (sorted) sequence of
times.- explicit_schedule(times)¶
Construct an explicit schedule.
By default returns a schedule with an empty list of times.
- times¶
The list of non-negative times [ms].
- events(t0, t1)¶
Returns a view of monotonically increasing time values in the half-open interval [t0, t1).
- class arbor.poisson_schedule¶
Describes a schedule according to a Poisson process.
- poisson_schedule(tstart, freq, seed)¶
Construct a Poisson schedule.
By default returns a schedule with events starting from
tstart= 0 ms, with an expected frequencyfreq= 10 kHz andseed= 0.
- tstart¶
The delivery time of the first event in the sequence [ms].
- freq¶
The expected frequency [kHz].
- seed¶
The seed for the random number generator.
- events(t0, t1)¶
Returns a view of monotonically increasing time values in the half-open interval [t0, t1).
- tstop¶
No events will be delivered after this time [ms].
An example of an event generator reads as follows:
import arbor as A
# define a Poisson schedule with a start time at 1 ms, expected frequency of 5 Hz,
# and the target cell's gid as seed
def event_generators(gid):
# label of the synapse on target cell, if multiple distribute cyclically
target = A.cell_local_label("syn", A.selection_policy.round_robin)
# Poisson schedule with a start time, event rate, and the target cell's gid as seed.
sched = A.poisson_schedule(tstart=1*U.ms, freq=5*U.Hz, seed=gid)
# Weight to apply to the events
weight = 0.1
return [A.event_generator(target, weight, sched)]