axon_population.place_population

axon_population.place_population(pos: None | tuple[ndarray] | ndarray | str = None, method: Literal['default', 'packing'] = 'default', overwrite=False, delta: float = 0.01, delta_trace: float | None = None, delta_in: float | None = None, n_iter: int = None, fit_to_size: bool = False, with_node_shift: bool = True)[source]

Place the population.

Parameters:

  • pos (None | tuple[np.ndarray] | np.ndarray) –

    if not None data to used to create the population. Supported data:

    • str: of the file path and name where to load the population properties.

    • tuple[np.ndarray] containing the population properties.

    • np.ndarray: of dimention (2, n_ax)

  • method (Literal["default", "packing"], optional) – method to use for the , by default “default”

  • overwrite (bool, optional) – If True placement is skipped if the population is already paced, by default False

  • delta (float) – axon-to-axon and axon to border minimal distance, by default .01

  • delta_trace (float | None, optional) – _description_, by default None

  • delta_in (float | None, optional) – _description_, by default None

  • fit_to_size (bool) – if true, the axon population is extended to fit within fascicle size, if not the population is kept as is

  • n_iter (int) – number of interation for the packing algorithm if the y-x axon coordinates are not specified

  • with_node_shift (bool) – if True also compute the Node of Ranviers shifts