SigmoidProfile#
- class braintools.init.SigmoidProfile(midpoint, slope=0.05, max_distance=None)#
Sigmoid distance profile.
Connection probability follows a sigmoid function that smoothly transitions from high to low probability around a midpoint distance.
- Parameters:
midpoint (
Array|ndarray|bool|number|bool|int|float|complex|Quantity) – Distance at which probability is 0.5.slope (
Array|ndarray|bool|number|bool|int|float|complex|Quantity) – Steepness of the sigmoid transition (higher values = steeper). A plain number is read per unit ofmidpoint(slope=0.05with a midpoint in um means 0.05 / um); pass a1/lengthQuantity such as0.05 / u.umto make it independent of that unit.max_distance (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|None) – Maximum connection distance (connections beyond this are set to 0).
Examples
>>> import numpy as np >>> import brainunit as u >>> from braintools.init import SigmoidProfile >>> >>> profile = SigmoidProfile( ... midpoint=100.0 * u.um, ... slope=0.05, ... max_distance=300.0 * u.um ... ) >>> distances = np.array([0, 50, 100, 150, 200, 300]) * u.um >>> probs = profile.probability(distances)