AxonalArborization#
- class braintools.conn.AxonalArborization(arborization_radius=150.0, density=0.3, weight=None, delay=None, allow_self_connections=False, **kwargs)#
Axonal arborization patterns.
Models spatial axonal arborization with local clustering of synaptic contacts around branch points.
- Parameters:
arborization_radius (
float|Quantity) – Radius of axonal arborization field. A plain number is interpreted in the unit ofpre_positions(so the default150.0means 150 um for micrometre positions).density (
float) – Synaptic density within arborization field. Must be in [0, 1].weight (
Initialization|float|int|ndarray|Array|Quantity|None) – Weight initialization.delay (
Initialization|float|int|ndarray|Array|Quantity|None) – Delay initialization.allow_self_connections (
bool) – Whether a neuron may connect to itself. DefaultFalse.
Notes
A pair within
arborization_radiusconnects with probabilitydensity. Pair probabilities are evaluated in chunks of presynaptic rows of bounded size, so peak memory does not grow withpre_size * post_size. The random draws are the same as in version 0.3, so a givenseedgives the same edges. Generation runs on the host with NumPy and cannot be traced byjax.jit,jax.vmaporjax.grad.Examples
>>> import brainunit as u >>> import numpy as np >>> from braintools.conn import AxonalArborization >>> positions = np.random.RandomState(0).uniform(0, 500, (60, 2)) * u.um >>> arbor = AxonalArborization(arborization_radius=100 * u.um, density=0.3, seed=0) >>> result = arbor(pre_size=60, post_size=60, ... pre_positions=positions, post_positions=positions) >>> result.n_connections 113