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

Class representing a current injection into a group of neurons. More...

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

Public Member Functions

def __init__ (self, name)
 Init CurrentSource. More...
 
def size (self)
 Number of neuron in the injected population. More...
 
def size (self, _)
 
def set_current_source_model (self, model, param_space, var_space)
 Set curront source model, its parameters and initial variables. More...
 
def add_to (self, nn_model, pop)
 Inject this CurrentSource into population and add it 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 current source. More...
 
def __init__ (self, name)
 Init CurrentSource. More...
 
def size (self)
 Number of neuron in the injected population. More...
 
def size (self, _)
 
def set_current_source_model (self, model, param_space, var_space)
 Set curront source model, its parameters and initial variables. More...
 
def add_to (self, nn_model, pop)
 Inject this CurrentSource into population and add it 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 current source. 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

 current_source_model
 
 target_pop
 
 pop
 
- Public Attributes inherited from pygenn.genn_groups.Group
 name
 
 vars
 
 extra_global_params
 

Detailed Description

Class representing a current injection into a group of neurons.

Constructor & Destructor Documentation

◆ __init__() [1/2]

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

Init CurrentSource.

Parameters
namestring name of the current source

◆ __init__() [2/2]

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

Init CurrentSource.

Parameters
namestring name of the current source

Member Function Documentation

◆ add_extra_global_param() [1/2]

def pygenn.genn_groups.CurrentSource.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.CurrentSource.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.CurrentSource.add_to (   self,
  nn_model,
  pop 
)

Inject this CurrentSource into population and add it to the GeNN NNmodel.

Parameters
popinstance of NeuronGroup into which this CurrentSource should be injected
nn_modelGeNN NNmodel

◆ add_to() [2/2]

def pygenn.genn_groups.CurrentSource.add_to (   self,
  nn_model,
  pop 
)

Inject this CurrentSource into population and add it to the GeNN NNmodel.

Parameters
popinstance of NeuronGroup into which this CurrentSource should be injected
nn_modelGeNN NNmodel

◆ load() [1/2]

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

◆ load() [2/2]

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

◆ reinitialise() [1/2]

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

Reinitialise current source.

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

◆ reinitialise() [2/2]

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

Reinitialise current source.

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

◆ set_current_source_model() [1/2]

def pygenn.genn_groups.CurrentSource.set_current_source_model (   self,
  model,
  param_space,
  var_space 
)

Set curront source 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_current_source_model() [2/2]

def pygenn.genn_groups.CurrentSource.set_current_source_model (   self,
  model,
  param_space,
  var_space 
)

Set curront source 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

◆ size() [1/4]

def pygenn.genn_groups.CurrentSource.size (   self)

Number of neuron in the injected population.

◆ size() [2/4]

def pygenn.genn_groups.CurrentSource.size (   self,
  _ 
)

◆ size() [3/4]

def pygenn.genn_groups.CurrentSource.size (   self)

Number of neuron in the injected population.

◆ size() [4/4]

def pygenn.genn_groups.CurrentSource.size (   self,
  _ 
)

Member Data Documentation

◆ current_source_model

pygenn.genn_groups.CurrentSource.current_source_model

◆ pop

pygenn.genn_groups.CurrentSource.pop

◆ target_pop

pygenn.genn_groups.CurrentSource.target_pop

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