class Synapse

The Synapse object is the receiving end of a connection between cells.

Public Fields

Compartment* Cmp

Pointer to the Compartment that owns this synapse

int PreviousSpikeTime

TimeStep when this synapse last had a spike

Augmentation* synAugmentation

If synaptic augmentation is activated, allocate an augmentation object

Public Methods

Synapse()

Default constructor

Synapse(SynapseDef* SYNDEF, Compartment* CMP, Random* RN)

Primary Constructor used when building brain from input file.

~Synapse()

Destructor, notifies memory tracker that resources have been freed

void ReceiveMsg(int TimeStep)

Receive an incoming spike from another cell.

void DoPositiveLearning(int TimeStep)

Whenever the parent cmp fires, this function checks to see if the synapse received an incoming spike message within the positive learning window.

int Save( FILE* out )

Write Synaptic data to a file.

void Load( FILE* in, char* nothing )

Load Synaptic data from a file.

int getID()

Function to compute the ID of this synapse by calculating the offset from the front of the array.

Public Members

ID of this Synapse within the compartment (0n)

Documentation

The Synapse object is the receiving end of a connection between cells. Owned by some compartment within the cell, it is called to do processing whenever it receives a message from the sending side. That processing includes placing it on the compartment's active list, where it contributes to the compartment voltage as specified by the PSG template & factors, and does learning &c.

ID of this Synapse within the compartment (0n)

ID of this Synapse within the compartment (0n)

Compartment* Cmp

Pointer to the Compartment that owns this synapse

int PreviousSpikeTime

TimeStep when this synapse last had a spike

Augmentation* synAugmentation

If synaptic augmentation is activated, allocate an augmentation object

Synapse()

Default constructor

Synapse(SynapseDef* SYNDEF, Compartment* CMP, Random* RN)

Primary Constructor used when building brain from input file.

Parameters:

SYNDEF - pointer to auxillary synase data. Learning, PSG, FD.
CMP - pointer to parent Compartment object
RN - pointer to random number generator

~Synapse()

Destructor, notifies memory tracker that resources have been freed

void ReceiveMsg(int TimeStep)

Receive an incoming spike from another cell. Called by the parent cmp when it receives a SPIKE message. Computes a modification factor for the generic spike template according to various internal values and updates spike time histories.

Parameters:

- TimeStep iteration of Brain::DoThink

void DoPositiveLearning(int TimeStep)

Whenever the parent cmp fires, this function checks to see if the synapse received an incoming spike message within the positive learning window. (In other words, whether this synapse contributed to the firing. If so, the USE value is modified according to the value in the learning table for the interval. This function is only called if the synapse was declared as using positive learning in the input file

Parameters:

- TimeStep iteration of Brain::DoThink

int Save( FILE* out )

Write Synaptic data to a file. Called by Compartment object.

Parameters:

out - File stream where data is sent

Returns:

number of bytes written

void Load( FILE* in, char* nothing )

Load Synaptic data from a file. Called by Compartment object.

Parameters:

in - File stream where data comes from
nothing - character string to make pointers use. Will hopefully be phased out

int getID()

Function to compute the ID of this synapse by calculating the offset from the front of the array. This allows memory to be saved since a separate variable for the id does not need to be kept.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java