axon_population.create_population_from_data

axon_population.create_population_from_data(data: tuple[ndarray] | ndarray | str)[source]

create the population directely from the values

Note

If column are not precised, the order for the data must be:

Types

Diameters

y-position

optional

z-position

optional

node shift

optional

For str indexed objects (dict or pandas.DataFrame) the respective indexes of the column above must be: “types”, “diameters”, “y” (optional), “z” (optional), “node_shift” (optional).

Parameters:

data (tuple[np.ndarray] | np.ndarray | str) –

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) or (4, n_ax), arange in the following order: types, diameters, y (optional), z (optional), node_shift (optional).