GeNN  3.3.0
GPU enhanced Neuronal Networks (GeNN)
pygenn.genn_groups.SynapseGroup Class Reference

Class representing synaptic connection between two groups of neurons. More...

Inheritance diagram for pygenn.genn_groups.SynapseGroup:
pygenn.genn_groups.Group pygenn.genn_groups.Group

Public Member Functions

def __init__ (self, name)
 Init SynapseGroup. More...
 
def num_synapses (self)
 Number of synapses in group. More...
 
def weight_update_var_size (self)
 Size of each weight update variable. More...
 
def max_row_length (self)
 
def set_psm_var (self, var_name, values)
 Set values for a postsynaptic model variable. More...
 
def set_pre_var (self, var_name, values)
 Set values for a presynaptic variable. More...
 
def set_post_var (self, var_name, values)
 Set values for a postsynaptic variable. More...
 
def set_weight_update (self, model, param_space, var_space, pre_var_space, post_var_space)
 Set weight update model, its parameters and initial variables. More...
 
def set_post_syn (self, model, param_space, var_space)
 Set postsynaptic model, its parameters and initial variables. More...
 
def get_var_values (self, var_name)
 
def is_connectivity_init_required (self)
 
def matrix_type (self)
 Type of the projection matrix. More...
 
def matrix_type (self, matrix_type)
 
def is_ragged (self)
 Tests whether synaptic connectivity uses Ragged format. More...
 
def is_bitmask (self)
 Tests whether synaptic connectivity uses Bitmask format. More...
 
def is_dense (self)
 Tests whether synaptic connectivity uses dense format. More...
 
def has_individual_synapse_vars (self)
 Tests whether synaptic connectivity has individual weights. More...
 
def has_individual_postsynaptic_vars (self)
 Tests whether synaptic connectivity has individual postsynaptic model variables. More...
 
def set_sparse_connections (self, pre_indices, post_indices)
 Set ragged foramt connections between two groups of neurons. More...
 
def set_connected_populations (self, source, target)
 Set two groups of neurons connected by this SynapseGroup. More...
 
def add_to (self, model_spec, delay_steps)
 Add this SynapseGroup to the GeNN NNmodel. More...
 
def add_extra_global_param (self, param_name, param_values)
 Add extra global parameter. More...
 
def load (self, slm, scalar)
 
def reinitialise (self, slm, scalar)
 Reinitialise synapse group. More...
 
def __init__ (self, name)
 Init SynapseGroup. More...
 
def num_synapses (self)
 Number of synapses in group. More...
 
def weight_update_var_size (self)
 Size of each weight update variable. More...
 
def max_row_length (self)
 
def set_psm_var (self, var_name, values)
 Set values for a postsynaptic model variable. More...
 
def set_pre_var (self, var_name, values)
 Set values for a presynaptic variable. More...
 
def set_post_var (self, var_name, values)
 Set values for a postsynaptic variable. More...
 
def set_weight_update (self, model, param_space, var_space, pre_var_space, post_var_space)
 Set weight update model, its parameters and initial variables. More...
 
def set_post_syn (self, model, param_space, var_space)
 Set postsynaptic model, its parameters and initial variables. More...
 
def get_var_values (self, var_name)
 
def is_connectivity_init_required (self)
 
def matrix_type (self)
 Type of the projection matrix. More...
 
def matrix_type (self, matrix_type)
 
def is_yale (self)
 Tests whether synaptic connectivity uses Yale format. More...
 
def is_ragged (self)
 Tests whether synaptic connectivity uses Ragged format. More...
 
def is_bitmask (self)
 Tests whether synaptic connectivity uses Bitmask format. More...
 
def is_dense (self)
 Tests whether synaptic connectivity uses dense format. More...
 
def has_individual_synapse_vars (self)
 Tests whether synaptic connectivity has individual weights. More...
 
def has_individual_postsynaptic_vars (self)
 Tests whether synaptic connectivity has individual postsynaptic model variables. More...
 
def set_sparse_connections (self, pre_indices, post_indices)
 Set yale or ragged foramt connections between two groups of neurons. More...
 
def set_connected_populations (self, source, target)
 Set two groups of neurons connected by this SynapseGroup. More...
 
def add_to (self, nn_model, delay_steps)
 Add this SynapseGroup to the GeNN NNmodel. More...
 
def add_extra_global_param (self, param_name, param_values)
 Add extra global parameter. More...
 
def load (self, slm, scalar)
 
def reinitialise (self, slm, scalar)
 Reinitialise synapse group. More...
 
- Public Member Functions inherited from pygenn.genn_groups.Group
def __init__ (self, name)
 Init Group. More...
 
def set_var (self, var_name, values)
 Set values for a Variable. More...
 
def __init__ (self, name)
 Init Group. More...
 
def set_var (self, var_name, values)
 Set values for a Variable. More...
 

Public Attributes

 connections_set
 
 w_update
 
 postsyn
 
 src
 
 trg
 
 psm_vars
 
 pre_vars
 
 post_vars
 
 connectivity_initialiser
 
 synapse_order
 
 ind
 
 row_lengths
 
 pop
 
 indInG
 
- Public Attributes inherited from pygenn.genn_groups.Group
 name
 
 vars
 
 extra_global_params
 

Detailed Description

Class representing synaptic connection between two groups of neurons.

Constructor & Destructor Documentation

◆ __init__() [1/2]

def pygenn.genn_groups.SynapseGroup.__init__ (   self,
  name 
)

Init SynapseGroup.

Parameters
namestring name of the group

◆ __init__() [2/2]

def pygenn.genn_groups.SynapseGroup.__init__ (   self,
  name 
)

Init SynapseGroup.

Parameters
namestring name of the group

Member Function Documentation

◆ add_extra_global_param() [1/2]

def pygenn.genn_groups.SynapseGroup.add_extra_global_param (   self,
  param_name,
  param_values 
)

Add extra global parameter.

Parameters
param_namestring with the name of the extra global parameter
param_valuesiterable or a single value

◆ add_extra_global_param() [2/2]

def pygenn.genn_groups.SynapseGroup.add_extra_global_param (   self,
  param_name,
  param_values 
)

Add extra global parameter.

Parameters
param_namestring with the name of the extra global parameter
param_valuesiterable or a single value

◆ add_to() [1/2]

def pygenn.genn_groups.SynapseGroup.add_to (   self,
  model_spec,
  delay_steps 
)

Add this SynapseGroup to the GeNN NNmodel.

Parameters
model_specGeNN ModelSpec

◆ add_to() [2/2]

def pygenn.genn_groups.SynapseGroup.add_to (   self,
  nn_model,
  delay_steps 
)

Add this SynapseGroup to the GeNN NNmodel.

Parameters
nn_modelGeNN NNmodel

◆ get_var_values() [1/2]

def pygenn.genn_groups.SynapseGroup.get_var_values (   self,
  var_name 
)

◆ get_var_values() [2/2]

def pygenn.genn_groups.SynapseGroup.get_var_values (   self,
  var_name 
)

◆ has_individual_postsynaptic_vars() [1/2]

def pygenn.genn_groups.SynapseGroup.has_individual_postsynaptic_vars (   self)

Tests whether synaptic connectivity has individual postsynaptic model variables.

◆ has_individual_postsynaptic_vars() [2/2]

def pygenn.genn_groups.SynapseGroup.has_individual_postsynaptic_vars (   self)

Tests whether synaptic connectivity has individual postsynaptic model variables.

◆ has_individual_synapse_vars() [1/2]

def pygenn.genn_groups.SynapseGroup.has_individual_synapse_vars (   self)

Tests whether synaptic connectivity has individual weights.

◆ has_individual_synapse_vars() [2/2]

def pygenn.genn_groups.SynapseGroup.has_individual_synapse_vars (   self)

Tests whether synaptic connectivity has individual weights.

◆ is_bitmask() [1/2]

def pygenn.genn_groups.SynapseGroup.is_bitmask (   self)

Tests whether synaptic connectivity uses Bitmask format.

◆ is_bitmask() [2/2]

def pygenn.genn_groups.SynapseGroup.is_bitmask (   self)

Tests whether synaptic connectivity uses Bitmask format.

◆ is_connectivity_init_required() [1/2]

def pygenn.genn_groups.SynapseGroup.is_connectivity_init_required (   self)

◆ is_connectivity_init_required() [2/2]

def pygenn.genn_groups.SynapseGroup.is_connectivity_init_required (   self)

◆ is_dense() [1/2]

def pygenn.genn_groups.SynapseGroup.is_dense (   self)

Tests whether synaptic connectivity uses dense format.

◆ is_dense() [2/2]

def pygenn.genn_groups.SynapseGroup.is_dense (   self)

Tests whether synaptic connectivity uses dense format.

◆ is_ragged() [1/2]

def pygenn.genn_groups.SynapseGroup.is_ragged (   self)

Tests whether synaptic connectivity uses Ragged format.

◆ is_ragged() [2/2]

def pygenn.genn_groups.SynapseGroup.is_ragged (   self)

Tests whether synaptic connectivity uses Ragged format.

◆ is_yale()

def pygenn.genn_groups.SynapseGroup.is_yale (   self)

Tests whether synaptic connectivity uses Yale format.

◆ load() [1/2]

def pygenn.genn_groups.SynapseGroup.load (   self,
  slm,
  scalar 
)

◆ load() [2/2]

def pygenn.genn_groups.SynapseGroup.load (   self,
  slm,
  scalar 
)

◆ matrix_type() [1/4]

def pygenn.genn_groups.SynapseGroup.matrix_type (   self)

Type of the projection matrix.

◆ matrix_type() [2/4]

def pygenn.genn_groups.SynapseGroup.matrix_type (   self,
  matrix_type 
)

◆ matrix_type() [3/4]

def pygenn.genn_groups.SynapseGroup.matrix_type (   self)

Type of the projection matrix.

◆ matrix_type() [4/4]

def pygenn.genn_groups.SynapseGroup.matrix_type (   self,
  matrix_type 
)

◆ max_row_length() [1/2]

def pygenn.genn_groups.SynapseGroup.max_row_length (   self)

◆ max_row_length() [2/2]

def pygenn.genn_groups.SynapseGroup.max_row_length (   self)

◆ num_synapses() [1/2]

def pygenn.genn_groups.SynapseGroup.num_synapses (   self)

Number of synapses in group.

◆ num_synapses() [2/2]

def pygenn.genn_groups.SynapseGroup.num_synapses (   self)

Number of synapses in group.

◆ reinitialise() [1/2]

def pygenn.genn_groups.SynapseGroup.reinitialise (   self,
  slm,
  scalar 
)

Reinitialise synapse group.

Parameters
slmSharedLibraryModel instance for acccessing variables
scalarString specifying "scalar" type

◆ reinitialise() [2/2]

def pygenn.genn_groups.SynapseGroup.reinitialise (   self,
  slm,
  scalar 
)

Reinitialise synapse group.

Parameters
slmSharedLibraryModel instance for acccessing variables
scalarString specifying "scalar" type

◆ set_connected_populations() [1/2]

def pygenn.genn_groups.SynapseGroup.set_connected_populations (   self,
  source,
  target 
)

Set two groups of neurons connected by this SynapseGroup.

Parameters
sourcestring name of the presynaptic neuron group
targetstring name of the postsynaptic neuron group

◆ set_connected_populations() [2/2]

def pygenn.genn_groups.SynapseGroup.set_connected_populations (   self,
  source,
  target 
)

Set two groups of neurons connected by this SynapseGroup.

Parameters
sourcestring name of the presynaptic neuron group
targetstring name of the postsynaptic neuron group

◆ set_post_syn() [1/2]

def pygenn.genn_groups.SynapseGroup.set_post_syn (   self,
  model,
  param_space,
  var_space 
)

Set postsynaptic model, its parameters and initial variables.

Parameters
modeltype as string of intance of the model
param_spacedict with model parameters
var_spacedict with model variables

◆ set_post_syn() [2/2]

def pygenn.genn_groups.SynapseGroup.set_post_syn (   self,
  model,
  param_space,
  var_space 
)

Set postsynaptic model, its parameters and initial variables.

Parameters
modeltype as string of intance of the model
param_spacedict with model parameters
var_spacedict with model variables

◆ set_post_var() [1/2]

def pygenn.genn_groups.SynapseGroup.set_post_var (   self,
  var_name,
  values 
)

Set values for a postsynaptic variable.

Parameters
var_namestring with the name of the presynaptic variable
valuesiterable or a single value

◆ set_post_var() [2/2]

def pygenn.genn_groups.SynapseGroup.set_post_var (   self,
  var_name,
  values 
)

Set values for a postsynaptic variable.

Parameters
var_namestring with the name of the presynaptic variable
valuesiterable or a single value

◆ set_pre_var() [1/2]

def pygenn.genn_groups.SynapseGroup.set_pre_var (   self,
  var_name,
  values 
)

Set values for a presynaptic variable.

Parameters
var_namestring with the name of the presynaptic variable
valuesiterable or a single value

◆ set_pre_var() [2/2]

def pygenn.genn_groups.SynapseGroup.set_pre_var (   self,
  var_name,
  values 
)

Set values for a presynaptic variable.

Parameters
var_namestring with the name of the presynaptic variable
valuesiterable or a single value

◆ set_psm_var() [1/2]

def pygenn.genn_groups.SynapseGroup.set_psm_var (   self,
  var_name,
  values 
)

Set values for a postsynaptic model variable.

Parameters
var_namestring with the name of the postsynaptic model variable
valuesiterable or a single value

◆ set_psm_var() [2/2]

def pygenn.genn_groups.SynapseGroup.set_psm_var (   self,
  var_name,
  values 
)

Set values for a postsynaptic model variable.

Parameters
var_namestring with the name of the postsynaptic model variable
valuesiterable or a single value

◆ set_sparse_connections() [1/2]

def pygenn.genn_groups.SynapseGroup.set_sparse_connections (   self,
  pre_indices,
  post_indices 
)

Set ragged foramt connections between two groups of neurons.

Parameters
pre_indicesndarray of presynaptic indices
post_indicesndarray of postsynaptic indices

◆ set_sparse_connections() [2/2]

def pygenn.genn_groups.SynapseGroup.set_sparse_connections (   self,
  pre_indices,
  post_indices 
)

Set yale or ragged foramt connections between two groups of neurons.

Parameters
pre_indicesndarray of presynaptic indices
post_indicesndarray of postsynaptic indices

◆ set_weight_update() [1/2]

def pygenn.genn_groups.SynapseGroup.set_weight_update (   self,
  model,
  param_space,
  var_space,
  pre_var_space,
  post_var_space 
)

Set weight update model, its parameters and initial variables.

Parameters
modeltype as string of intance of the model
param_spacedict with model parameters
var_spacedict with model variables
pre_var_spacedict with model presynaptic variables
post_var_spacedict with model postsynaptic variables

◆ set_weight_update() [2/2]

def pygenn.genn_groups.SynapseGroup.set_weight_update (   self,
  model,
  param_space,
  var_space,
  pre_var_space,
  post_var_space 
)

Set weight update model, its parameters and initial variables.

Parameters
modeltype as string of intance of the model
param_spacedict with model parameters
var_spacedict with model variables
pre_var_spacedict with model presynaptic variables
post_var_spacedict with model postsynaptic variables

◆ weight_update_var_size() [1/2]

def pygenn.genn_groups.SynapseGroup.weight_update_var_size (   self)

Size of each weight update variable.

◆ weight_update_var_size() [2/2]

def pygenn.genn_groups.SynapseGroup.weight_update_var_size (   self)

Size of each weight update variable.

Member Data Documentation

◆ connections_set

pygenn.genn_groups.SynapseGroup.connections_set

◆ connectivity_initialiser

pygenn.genn_groups.SynapseGroup.connectivity_initialiser

◆ ind

pygenn.genn_groups.SynapseGroup.ind

◆ indInG

pygenn.genn_groups.SynapseGroup.indInG

◆ pop

pygenn.genn_groups.SynapseGroup.pop

◆ post_vars

pygenn.genn_groups.SynapseGroup.post_vars

◆ postsyn

pygenn.genn_groups.SynapseGroup.postsyn

◆ pre_vars

pygenn.genn_groups.SynapseGroup.pre_vars

◆ psm_vars

pygenn.genn_groups.SynapseGroup.psm_vars

◆ row_lengths

pygenn.genn_groups.SynapseGroup.row_lengths

◆ src

pygenn.genn_groups.SynapseGroup.src

◆ synapse_order

pygenn.genn_groups.SynapseGroup.synapse_order

◆ trg

pygenn.genn_groups.SynapseGroup.trg

◆ w_update

pygenn.genn_groups.SynapseGroup.w_update

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