brainmass.sigmoid

brainmass.sigmoid#

brainmass.sigmoid(x, vmax, v0, r)[source]#

Convert membrane potential to firing rate via a sigmoid.

\[S(x) = \frac{v_{max}}{1 + \exp\!\big(r (v_0 - x)\big)}\]

Parameters:

x (Array | ndarray | bool | number | bool | int | float | complex | Quantity) – Input membrane potential.
vmax (Array | ndarray | bool | number | bool | int | float | complex | Quantity) – Maximum firing rate.
v0 (Array | ndarray | bool | number | bool | int | float | complex | Quantity) – Firing threshold (potential at half-maximum rate).
r (Array | ndarray | bool | number | bool | int | float | complex | Quantity) – Steepness of the sigmoid.

Returns:

Firing rate in the open interval (0, vmax).

Return type: