axon_block_threshold

nrv.ui.axon_block_threshold(axon: axon, amp_max: float, update_func: Callable, AP_start: float, t_sim: float = 10, tol: float = 1, freq: float | None = None, verbose: bool = True, args_update=dict | None, save_path: str | None = None, **kwargs) → <MagicMock name='mock.float64' id='139958334311312'>[source]

Find the block threshold of an axon with arbitrary stimulation settings.

Parameters:

  • axon (axon) – axon object to simulation

  • amp_max (float) – maximum amplitude for the binary search, in µA

  • update_func (Callable) – Callable object to update the axon stimulation parameters between each binary search iteration

  • AP_start (float) – timestamp of the test pulse start, in ms.

  • t_sim (float, optional) – Simulation duration, in ms, by default 5

  • tol (float, optional) – Search tolerance, in %, by default 1

  • freq (float, optional) – Frequency of the stimulation, for KES block, by default None

  • verbose (bool, optional) – Verbosity of the search, by default True

  • args_update (arg, optional) – update_func arguments, by default None

  • save_path (str, optional) – if not none, raster_plot and plot_x_t of axon results are saved in save_path

Returns:

current_amp – The block threshold found with the binary search.

Return type:

np.float64