create_trapezoid_current#

create_trapezoid_current(
n_pools: int,
t_points: int,
timestep__ms: Quantity__ms,
amplitudes__nA: Quantity__nA | list[Quantity__nA],
rise_times__ms: Quantity__ms | list[Quantity__ms] = 100.0 * pq.ms,
plateau_times__ms: Quantity__ms | list[Quantity__ms] = 200.0 * pq.ms,
fall_times__ms: Quantity__ms | list[Quantity__ms] = 100.0 * pq.ms,
offsets__nA: Quantity__nA | list[Quantity__nA] = 0.0 * pq.nA,
delays__ms: Quantity__ms | list[Quantity__ms] = 0.0 * pq.ms,
) → s]][source]#

Create a matrix of trapezoidal 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

  • amplitudes__nA (float | list[float]) –

    Amplitude(s) of the trapezoidal current(s) in nano Amperes.

    Must be:

    • Single float: used for all pools

    • List of floats: must match n_pools

  • rise_times__ms (float | list[float]) –

    Duration(s) of the rising phase in milliseconds.

    Must be:

    • Single float: used for all pools

    • List of floats: must match n_pools

  • plateau_times__ms (float | list[float]) –

    Duration(s) of the plateau phase in milliseconds.

    Must be:

    • Single float: used for all pools

    • List of floats: must match n_pools

  • fall_times__ms (float | list[float]) –

    Duration(s) of the falling phase in milliseconds.

    Must be:

    • Single float: used for all pools

    • List of floats: must match n_pools

  • offsets__nA (float | list[float]) –

    DC offset(s) to add to the trapezoidal current(s) in nano Amperes.

    Must be:

    • Single float: used for all pools

    • List of floats: must match n_pools

  • delays__ms (float | list[float]) –

    Delay(s) before starting the trapezoid in milliseconds.

    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:

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

Return type:

INPUT_CURRENT__AnalogSignal