create_step_current

create_step_current(

n_pools: int,

t_points: int,

timestep__ms: Quantity__ms,

step_heights__nA: Quantity__nA | list[Quantity__nA],

step_durations__ms: Quantity__ms | list[Quantity__ms],

offsets__nA: Quantity__nA | list[Quantity__nA] = 0.0 * pq.nA,

) → s]]

Create a matrix of step currents for multiple pools.

Parameters:

• n_pools (int) – Number of current pools to generate

• t_points (int) – Number of time points

• timestep__ms (Quantity__ms) – Time step in milliseconds as a Quantity

• step_heights__nA (Quantity__nA | list[Quantity__nA]) –

  Step height(s) for the current(s) in nanoamperes.

  Must be:

  • Single Quantity: used for all pools

  • List of Quantities: must match n_pools

• step_durations__ms (Quantity__ms | list[Quantity__ms]) –

  Step duration(s) in milliseconds as Quantities.

  Must be:

  • Single Quantity: used for all pools

  • List of Quantities: must match n_pools

• offsets__nA (Quantity__nA | list[Quantity__nA]) –

  DC offset(s) to add to the step current(s) in nanoamperes.

  Must be:

  • Single Quantity: used for all pools

  • List of Quantities: must match n_pools

Raises:

ValueError – If the parameters are lists and the length of the parameters does not match n_pools

Returns:

Analog signal of shape (t_points, n_pools) * pq.nA containing step currents

Return type:

INPUT_CURRENT__AnalogSignal