Variable class

(Shortest import: from brian2.core.variables import Variable)

class brian2.core.variables.Variable(name, dimensions=Dimension(), owner=None, dtype=None, scalar=False, constant=False, read_only=False, dynamic=False, array=False)

Bases: CacheKey

An object providing information about model variables (including implicit variables such as t or xi). This class should never be instantiated outside of testing code, use one of its subclasses instead.

Attributes

array	Whether the variable is an array
constant	Whether the variable is constant during a run
dim	The variable's dimensions.
dtype	The dtype used for storing the variable.
dtype_str	String representation of the numpy dtype
dynamic	Whether the variable is dynamically sized (only for non-scalars)
is_boolean
is_integer
name	The variable's name.
owner	The Group to which this variable belongs.
read_only	Whether the variable is read-only
scalar	Whether the variable is a scalar
unit	The Unit of this variable

Methods

get_addressable_value(name, group)	Get the value (without units) of this variable in a form that can be indexed in the context of a group.
get_addressable_value_with_unit(name, group)	Get the value (with units) of this variable in a form that can be indexed in the context of a group.
get_len()	Get the length of the value associated with the variable or 0 for a scalar variable.
get_value()	Return the value associated with the variable (without units).
get_value_with_unit()	Return the value associated with the variable (with units).
set_value(value)	Set the value associated with the variable.

Details

array

Whether the variable is an array

constant

Whether the variable is constant during a run

dim

The variable’s dimensions.

dtype

The dtype used for storing the variable.

dtype_str

String representation of the numpy dtype

dynamic

Whether the variable is dynamically sized (only for non-scalars)

is_boolean

is_integer

name

The variable’s name.

owner

The Group to which this variable belongs.

read_only

Whether the variable is read-only

scalar

Whether the variable is a scalar

unit

The Unit of this variable

get_addressable_value(name, group)

Get the value (without units) of this variable in a form that can be indexed in the context of a group. For example, if a postsynaptic variable x is accessed in a synapse S as S.x_post, the synaptic indexing scheme can be used.

get_addressable_value_with_unit(name, group)

Get the value (with units) of this variable in a form that can be indexed in the context of a group. For example, if a postsynaptic variable x is accessed in a synapse S as S.x_post, the synaptic indexing scheme can be used.

get_len()

Get the length of the value associated with the variable or 0 for a scalar variable.

get_value()

Return the value associated with the variable (without units). This is the way variables are accessed in generated code.

get_value_with_unit()

Return the value associated with the variable (with units).

set_value(value)

Set the value associated with the variable.