is_blocked

nrv.ui.is_blocked(results: axon_results, AP_start: float | None = None, freq: float | None = None, t_refractory: float = 1) → axon_results[source]

Evaluate the impact od a blocking stimulation on axon (see axon_results.block_summary) and remove most of the axon_results keys to alliviate RAM usage.

Note

Only the following keys kept by the fuction

  • ID

  • L

  • V_mem_raster_position

  • V_mem_raster_x_position

  • V_mem_raster_time_index

  • V_mem_raster_time

  • myelinated

  • y

  • z

  • diameter

  • intra_stim_starts

  • tstop

  • intra_stim_positions

  • extracellular_electrode_x

  • blocked

  • has_onset

  • n_onset

Parameters:

  • results (axon_results) – results of the axon simulation.

  • save (bool, optional) – if true, the block status is saved as a line in a .csv file, by default False

  • fdir (str, optional) – Path where the conductivity should be saved, the saving file will be fdir+block_summary.csv, by default “”

Note

If save is true, the data arranged as column of a same line in the following order:

  • ID

  • y

  • z

  • diameter

  • myelinated

  • is_blocked

  • has_onset

  • n_onset

Returns:

updated results.

Return type:

axon_results