GeNN  4.9.0
GPU enhanced Neuronal Networks (GeNN)
pygenn.genn_groups.NeuronGroup Class Reference

Class representing a group of neurons. More...

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

Public Member Functions

def __init__ (self, name, model)
 Init NeuronGroup. More...
 
def current_spikes (self)
 Current spikes from GeNN. More...
 
def current_spikes (self, spikes)
 Current spikes from GeNN. More...
 
def current_spike_events (self)
 Current spike events from GeNN. More...
 
def current_spike_events (self, spike_events)
 Current spike events from GeNN. More...
 
def spike_recording_data (self)
 
def spike_event_recording_data (self)
 
def delay_slots (self)
 Maximum delay steps needed for this group. More...
 
def size (self)
 
def spike_recording_enabled (self)
 
def spike_recording_enabled (self, enabled)
 
def spike_event_recording_enabled (self)
 
def spike_event_recording_enabled (self, enabled)
 
def set_neuron (self, model, param_space, var_space)
 Set neuron, its parameters and initial variables. More...
 
def add_to (self, num_neurons)
 Add this NeuronGroup to a model. More...
 
def pull_spikes_from_device (self)
 Wrapper around GeNNModel.pull_spikes_from_device. More...
 
def pull_spike_events_from_device (self)
 Wrapper around GeNNModel.pull_spike_events_from_device. More...
 
def pull_current_spikes_from_device (self)
 Wrapper around GeNNModel.pull_current_spikes_from_device. More...
 
def pull_current_spike_events_from_device (self)
 Wrapper around GeNNModel.pull_current_spike_events_from_device. More...
 
def pull_spike_times_from_device (self)
 Helper to pull spike times from device. More...
 
def pull_spike_event_times_from_device (self)
 Helper to pull spike event times from device. More...
 
def pull_prev_spike_times_from_device (self)
 Helper to pull previous spike times from device. More...
 
def pull_prev_spike_event_times_from_device (self)
 Helper to pull previous spike event times from device. More...
 
def push_spikes_to_device (self)
 Wrapper around GeNNModel.push_spikes_to_device. More...
 
def push_spike_events_to_device (self)
 Wrapper around GeNNModel.push_spike_events_to_device. More...
 
def push_current_spikes_to_device (self)
 Wrapper around GeNNModel.push_current_spikes_to_device. More...
 
def push_current_spike_events_to_device (self)
 Wrapper around GeNNModel.push_current_spike_events_to_device. More...
 
def push_spike_times_to_device (self)
 Helper to push spike times to device. More...
 
def push_spike_event_times_to_device (self)
 Helper to push spike event times to device. More...
 
def push_prev_spike_times_to_device (self)
 Helper to push previous spike times to device. More...
 
def push_prev_spike_event_times_to_device (self)
 Helper to push previous spike event times to device. More...
 
def load (self, num_recording_timesteps)
 Loads neuron group. More...
 
def unload (self)
 
def load_init_egps (self)
 
def reinitialise (self)
 Reinitialise neuron group. More...
 
- Public Member Functions inherited from pygenn.genn_groups.Group
def __init__ (self, name, model)
 Init Group. More...
 
def set_var (self, var_name, values)
 Set values for a Variable. More...
 
def add_extra_global_param (self, param_name, param_values)
 Set extra global parameter. More...
 
def set_extra_global_param (self, param_name, param_values)
 Set extra global parameter. More...
 
def pull_state_from_device (self)
 Wrapper around GeNNModel.pull_state_from_device. More...
 
def pull_var_from_device (self, var_name)
 Wrapper around GeNNModel.pull_var_from_device. More...
 
def pull_extra_global_param_from_device (self, egp_name, size=None)
 Wrapper around GeNNModel.pull_extra_global_param_from_device. More...
 
def push_state_to_device (self)
 Wrapper around GeNNModel.push_state_to_device. More...
 
def push_var_to_device (self, var_name)
 Wrapper around GeNNModel.push_var_to_device. More...
 
def push_extra_global_param_to_device (self, egp_name, size=None)
 Wrapper around GeNNModel.push_extra_global_param_to_device. More...
 

Public Attributes

 neuron
 
 spikes
 
 spike_count
 
 spike_events
 
 spike_event_count
 
 spike_que_ptr
 
 spike_times
 
 prev_spike_times
 
 spike_event_times
 
 prev_spike_event_times
 
 pop
 
- Public Attributes inherited from pygenn.genn_groups.Group
 name
 
 vars
 
 extra_global_params
 

Detailed Description

Class representing a group of neurons.

Constructor & Destructor Documentation

◆ __init__()

def pygenn.genn_groups.NeuronGroup.__init__ (   self,
  name,
  model 
)

Init NeuronGroup.

Parameters
namestring name of the group
modelpygenn.genn_model.GeNNModel this neuron group is part of

Member Function Documentation

◆ add_to()

def pygenn.genn_groups.NeuronGroup.add_to (   self,
  num_neurons 
)

Add this NeuronGroup to a model.

Parameters
num_neuronsint number of neurons

◆ current_spike_events() [1/2]

def pygenn.genn_groups.NeuronGroup.current_spike_events (   self)

Current spike events from GeNN.

◆ current_spike_events() [2/2]

def pygenn.genn_groups.NeuronGroup.current_spike_events (   self,
  spike_events 
)

Current spike events from GeNN.

◆ current_spikes() [1/2]

def pygenn.genn_groups.NeuronGroup.current_spikes (   self)

Current spikes from GeNN.

◆ current_spikes() [2/2]

def pygenn.genn_groups.NeuronGroup.current_spikes (   self,
  spikes 
)

Current spikes from GeNN.

◆ delay_slots()

def pygenn.genn_groups.NeuronGroup.delay_slots (   self)

Maximum delay steps needed for this group.

◆ load()

def pygenn.genn_groups.NeuronGroup.load (   self,
  num_recording_timesteps 
)

Loads neuron group.

◆ load_init_egps()

def pygenn.genn_groups.NeuronGroup.load_init_egps (   self)

◆ pull_current_spike_events_from_device()

def pygenn.genn_groups.NeuronGroup.pull_current_spike_events_from_device (   self)

◆ pull_current_spikes_from_device()

def pygenn.genn_groups.NeuronGroup.pull_current_spikes_from_device (   self)

◆ pull_prev_spike_event_times_from_device()

def pygenn.genn_groups.NeuronGroup.pull_prev_spike_event_times_from_device (   self)

Helper to pull previous spike event times from device.

◆ pull_prev_spike_times_from_device()

def pygenn.genn_groups.NeuronGroup.pull_prev_spike_times_from_device (   self)

Helper to pull previous spike times from device.

◆ pull_spike_event_times_from_device()

def pygenn.genn_groups.NeuronGroup.pull_spike_event_times_from_device (   self)

Helper to pull spike event times from device.

◆ pull_spike_events_from_device()

def pygenn.genn_groups.NeuronGroup.pull_spike_events_from_device (   self)

◆ pull_spike_times_from_device()

def pygenn.genn_groups.NeuronGroup.pull_spike_times_from_device (   self)

Helper to pull spike times from device.

◆ pull_spikes_from_device()

def pygenn.genn_groups.NeuronGroup.pull_spikes_from_device (   self)

◆ push_current_spike_events_to_device()

def pygenn.genn_groups.NeuronGroup.push_current_spike_events_to_device (   self)

◆ push_current_spikes_to_device()

def pygenn.genn_groups.NeuronGroup.push_current_spikes_to_device (   self)

◆ push_prev_spike_event_times_to_device()

def pygenn.genn_groups.NeuronGroup.push_prev_spike_event_times_to_device (   self)

Helper to push previous spike event times to device.

◆ push_prev_spike_times_to_device()

def pygenn.genn_groups.NeuronGroup.push_prev_spike_times_to_device (   self)

Helper to push previous spike times to device.

◆ push_spike_event_times_to_device()

def pygenn.genn_groups.NeuronGroup.push_spike_event_times_to_device (   self)

Helper to push spike event times to device.

◆ push_spike_events_to_device()

def pygenn.genn_groups.NeuronGroup.push_spike_events_to_device (   self)

◆ push_spike_times_to_device()

def pygenn.genn_groups.NeuronGroup.push_spike_times_to_device (   self)

Helper to push spike times to device.

◆ push_spikes_to_device()

def pygenn.genn_groups.NeuronGroup.push_spikes_to_device (   self)

◆ reinitialise()

def pygenn.genn_groups.NeuronGroup.reinitialise (   self)

Reinitialise neuron group.

◆ set_neuron()

def pygenn.genn_groups.NeuronGroup.set_neuron (   self,
  model,
  param_space,
  var_space 
)

Set neuron, 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()

def pygenn.genn_groups.NeuronGroup.size (   self)

◆ spike_event_recording_data()

def pygenn.genn_groups.NeuronGroup.spike_event_recording_data (   self)

◆ spike_event_recording_enabled() [1/2]

def pygenn.genn_groups.NeuronGroup.spike_event_recording_enabled (   self)

◆ spike_event_recording_enabled() [2/2]

def pygenn.genn_groups.NeuronGroup.spike_event_recording_enabled (   self,
  enabled 
)

◆ spike_recording_data()

def pygenn.genn_groups.NeuronGroup.spike_recording_data (   self)

◆ spike_recording_enabled() [1/2]

def pygenn.genn_groups.NeuronGroup.spike_recording_enabled (   self)

◆ spike_recording_enabled() [2/2]

def pygenn.genn_groups.NeuronGroup.spike_recording_enabled (   self,
  enabled 
)

◆ unload()

def pygenn.genn_groups.NeuronGroup.unload (   self)

Member Data Documentation

◆ neuron

pygenn.genn_groups.NeuronGroup.neuron

◆ pop

pygenn.genn_groups.NeuronGroup.pop

◆ prev_spike_event_times

pygenn.genn_groups.NeuronGroup.prev_spike_event_times

◆ prev_spike_times

pygenn.genn_groups.NeuronGroup.prev_spike_times

◆ spike_count

pygenn.genn_groups.NeuronGroup.spike_count

◆ spike_event_count

pygenn.genn_groups.NeuronGroup.spike_event_count

◆ spike_event_times

pygenn.genn_groups.NeuronGroup.spike_event_times

◆ spike_events

pygenn.genn_groups.NeuronGroup.spike_events

◆ spike_que_ptr

pygenn.genn_groups.NeuronGroup.spike_que_ptr

◆ spike_times

pygenn.genn_groups.NeuronGroup.spike_times

◆ spikes

pygenn.genn_groups.NeuronGroup.spikes

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