create_ramp_current#
- myogen.utils.currents.create_ramp_current(n_pools, t_points, start_currents__muV, end_currents__muV, offsets__muV=0.0)[source]#
Create a matrix of ramp currents for multiple pools.
- Parameters:
n_pools (
int
) – Number of current pools to generatet_points (
int
) – Number of time pointsstart_currents__muV (
float
|list
[float
]) –Starting current(s) for the ramp in microvolts.
- Must be:
Single float: used for all pools
List of floats: must match n_pools
end_currents__muV (
float
|list
[float
]) –Ending current(s) for the ramp in microvolts.
- 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 ramp 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 ramp currents
- Return type: