create_step_current

myogen.utils.currents.create_step_current(n_pools, t_points, timestep_ms, step_heights__muV, step_durations__ms, offsets__muV=0.0)

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 (float) – Time step in milliseconds.

• step_heights__muV (float | list[float]) –

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

  Must be:

  • Single float: used for all pools

  • List of floats: must match n_pools

• step_durations__ms (float | list[float]) –

  Step duration(s) in milliseconds.

  Must be:

  • Single float: used for all pools

  • List of floats: must match n_pools

• offsets__muV (float | list[float]) –

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

  Must be:

  • Single float: used for all pools

  • List of floats: must match n_pools

Raises:

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

Returns:

Matrix of shape (n_pools, t_points) containing step currents

Return type:

INPUT_CURRENT__MATRIX