neuromodes.waves.get_balloon_params

neuromodes.waves.get_balloon_params(**overrides) dict

Return balloon model parameters with optional overrides.

Parameters

**overrides

Balloon model parameters to override default values. Must be positive.

Returns

dict

Balloon model parameters. - kappa: Signal decay rate [s^-1]. Default is 0.65. - gamma_h: Rate of elimination [s^-1]. Default is 0.41. - tau: Hemodynamic transit time [s]. Default is 0.98. - alpha: Grubb’s exponent [unitless]. Default is 0.32. - rho: Resting oxygen extraction fraction [unitless]. Default is 0.34. - V_0: Resting blood volume fraction [unitless]. Default is 0.02. - w_f: Frequency of blood flow response [rad/s]. Default is 0.56. - k1, k2, k3: Coefficients for BOLD signal equation [unitless]. Defaults are 3.72, 0.527, and 0.48, respectively.

Raises

ValueError

If any provided balloon model parameter name is invalid.

ValueError

If any provided balloon model parameter is non-positive or non-finite.