cleo.stimulators module

Contains basic stimulators.

class cleo.stimulators.StateVariableSetter(default_value: Any = 0, *, name: str = _Nothing.NOTHING, save_history: bool = True, variable_to_ctrl: str, unit: Unit)

Bases: Stimulator

Sets the given state variable of target neuron groups.

Method generated by attrs for class StateVariableSetter.

connect_to_neuron_group(neuron_group)

Connect device to given neuron_group.

If your device introduces any objects which Brian must keep track of, such as a NeuronGroup, Synapses, or Monitor, make sure to add these to brian_objects.

Parameters:

• neuron_group (NeuronGroup) –

• **kwparams (optional) – Passed from inject

neuron_groups: list[NeuronGroup]

unit: Unit

will be used in update()

Type:

Unit of controlled variable

update(ctrl_signal: float) → None

Set state variable of target neuron groups

Parameters:

ctrl_signal (float) – Value to update variable to, without unit. The unit provided on initialization is automatically multiplied.

variable_to_ctrl: str

Name of state variable to control