boone.spike

Class SpikeEvent

java.lang.Object

boone.spike.SpikeEvent

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<SpikeEvent>

public class SpikeEvent
extends java.lang.Object
implements java.lang.Comparable<SpikeEvent>, java.lang.Cloneable

This event is generated by the SpikingLink and SpikingNeuron objects in a SpikingNeuralNet, during the simulation of a spiking neural network. Each event represents an emitted or received spike. There are two static constants signaling whether a specific event represents an emitted or a received spike.

A SpikeEvent encapsulates

• the simulation time this event is raised
• a reference to the network component that generated it
• a reference to the network component that handles it
• a function describing the form of the spike that this event represents

If the event has the type PRE_SPIKE, it represents an emitted spike. In this case the encapsulated function describes the form of the spike. Any function can be used for this purpose, as long as it meets one of the following two requirements:

• f has a root at 0, a single maximum > 0 at max, is monotonically increasing in [0, max] and monotonically decreasing in [max, infinity], converging to 0
• f has a root at 0, a single maximum > 0 at max, is monotonically increasing in [0, max], monotonically decreasing in [max, min] where f(min) < 0 and monotonically increasing in [min, infinity] converging to 0

If the event has the type POST_SPIKE, it represents a received spike, that means a postsynaptic potential. In this case the encapsulated function describes the form of the postsynaptic potential. Any function can be used for this purpose, as long as it meets one of the following two requirements:

• f has a root at 0, a single maximum > 0 at max, is monotonically increasing in [0, max] and monotonically decreasing in [max, infinity], converging to 0
• f has a root at 0, a single minimum < 0 at min, is monotonically decreasing in [0, min] and monotonically increasing in [min, infinity], converging to 0

Version:

$Id: PotentialEvent.java 2285 2015-08-04 jmory $

Author:

Johannes Mory

Field Summary

Fields

Modifier and Type	Field and Description
static int	POST_SPIKE Indicates a post-synaptic spike.
static int	PRE_SPIKE Indicates a pre-synaptic spike.

Constructor Summary

Constructors

Constructor and Description
SpikeEvent() Create a new SpikeEvent object, with no references and timestamp 0.
SpikeEvent(double time, BrainPart origin, BrainPart destination, Function model, int type) Create a new SpikeEvent object, with the specified parameter values.

Method Summary

Modifier and Type	Method and Description
SpikeEvent	clone() Return a shallow copy of this SpikeEvent.
int	compareTo(SpikeEvent other) Compare this SpikeEvent with the specified SpikeEvent.
BrainPart	getDestination()
Function	getFunction()
BrainPart	getOrigin()
double	getTime()
int	getType() The type signals, if this event represents an emitted or received spike.
void	setDestination(BrainPart destination)
void	setFunction(Function function)
void	setOrigin(BrainPart origin)
void	setTime(double time)
void	setType(int type) The type signals, if this event represents an emitted or received spike.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PRE_SPIKE

public static final int PRE_SPIKE

Indicates a pre-synaptic spike.

See Also:

Constant Field Values

POST_SPIKE

public static final int POST_SPIKE

Indicates a post-synaptic spike.

See Also:

Constant Field Values

Constructor Detail

SpikeEvent

public SpikeEvent()

Create a new SpikeEvent object, with no references and timestamp 0.

SpikeEvent

public SpikeEvent(double time,
                  BrainPart origin,
                  BrainPart destination,
                  Function model,
                  int type)

Create a new SpikeEvent object, with the specified parameter values.

Parameters:

time - the simulation time this event is raised

origin - the network component that generated this event

destination - the network component that handles this event

model - the form of the spike that this event represents

type - signals if this event represents an emitted or received spike

Method Detail

getOrigin

public BrainPart getOrigin()

Returns:

the network component that generated this event

setOrigin

public void setOrigin(BrainPart origin)

Parameters:

origin - the network component that generated this event

getDestination

public BrainPart getDestination()

Returns:

the network component that handles this event

setDestination

public void setDestination(BrainPart destination)

Parameters:

destination - the network component that handles this event

getTime

public double getTime()

Returns:

the simulation time this event is raised

setTime

public void setTime(double time)

Parameters:

time - the simulation time this event is raised

getFunction

public Function getFunction()

Returns:

the form of the spike that this event represents

setFunction

public void setFunction(Function function)

Parameters:

function - the form of the spike that this event represents

getType

public int getType()

The type signals, if this event represents an emitted or received spike. To determine what kind of spike this event represents, compare the returned value with constants PRE_SPIKE and POST_SPIKE.

Returns:

the type of this event

setType

public void setType(int type)

The type signals, if this event represents an emitted or received spike. To determine what kind of spike this event represents, compare the returned value with constants PRE_SPIKE and POST_SPIKE.

Parameters:

type - the type of this event

compareTo

public int compareTo(SpikeEvent other)

Compare this SpikeEvent with the specified SpikeEvent.

Specified by:

compareTo in interface java.lang.Comparable<SpikeEvent>

Parameters:

other - the SpikeEvent to be compared

Returns:

• Negative value: This event is raised before the other.
• Zero: This event is raised at the same time as the other .
• Positive value: This event is raised after the other.

clone

public SpikeEvent clone()

Return a shallow copy of this SpikeEvent.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object