eit_forward.simulate_nerve

eit_forward.simulate_nerve(t_start: float = 1, duration: float = 0.2, amplitude: float = 5, expr: str | None = None, mask_labels: None | Iterable[str] | str = [], ax_list: None | list = None, fasc_list: None | list = None, sim_param: dict = {}, ax_param: dict = {}, save: bool = False)[source]

Simulate the neural context: fibres conductivity and extracellular context.

Parameters:

  • t_start (float) – Time to start current clamp in ms, by default 1.

  • duration (float) – Duration of current clamp in ms, by default 0.2.

  • amplitude (float) – Current amplitude of the clamp in uA, by default 5.

  • expr (str | None, optional) – To select a subpopulation of axon for the clamp, If not None mask is generated using pandas.DataFrame.eval() of this expression, by default None

  • mask_labels (None | Iterable[str] | str, optional) – To select a subpopulation of axon for the clamp, Label or list of labels already added to the axon populations population, by default []

  • ax_list (None | list) – To select a subpopulation of axon for the clamp, list of axons to insert the clamp on, if None, all axons are stimulated, by default None

  • fasc_list (None | list) – To select a subpopulation of axon for the clamp, list of fascicle to insert the clamp on, if None, all fascicle are stimulated, by default None

  • sim_param (dict, optional) – Nerve parameters to change before simulation, by default {}.

  • ax_param (dict, optional) – Axon parameters to change before simulation, by default {}.

  • save (bool, optional) – If True, save the simulation result, by default True.

Returns:

Results of the nerve simulation.

Return type:

nerve_results