5 Individulal unit identification, properties and parameters

Units populating a model are uniquely identified by their label, set at creation time. Where a single unit needs to be selected for a function, the corresponding argument to that function is designated L. Or, if an operation is supposed to affect many units, selected by a regex pattern on their labels, that argument is designated R.

Apart from the (arbitrary) label, units are classified as belonging to either Neuron or Synapse class, further belonging to a certain family and species. These categories are built-in, each species defining a set of parameters and state variables.

All available unit species are listed in Unit species.

Function: get_unit_properties (C, M, L)

Return the following attributes and properties of unit L, in order: label, class_name, family, species, as strings, followed by flags has_sources and is_not_altered.

Function: get_unit_parameter (C, M, L, P)

Get the value of unit L’s parameter P.

Function: set_unit_parameter (C, M, L, P, V)

Set unit L’s parameter P to a value of V.

Function: get_unit_vars (C, M, L)

Get the values of all state variables of unit L, returned as floats in the order they are listed in Unit species table.

Function: reset_unit (C, M, L)

Reset all state variables of unit L.

Function: get_units_matching (C, M, R)

Return all units with labels matching regex R.

Function: get_units_of_type (C, M, sp)

Return all units of a species sp.

Function: set_matching_neuron_parameter (C, M, R, P, V)

Set the value of parameter P to V in all neurons labelled matching regex R.

Function: set_matching_synapse_parameter (C, M, Rs, Rt, P, V)

Set the value of parameter P to V in all synapses connecting, resp., any neurons labelled matching regexes Rs and Rt.

Function: revert_matching_unit_parameters (C, M, R)

Revert to defaults all parameters of units labelled matching regex R.

Function: decimate (C, M, R, frac)

Delete a random frac of all units matching regex R.

Function: putout (C, M, R)

Delete all units matching regex R.