LinearProfile

class braintools.init.LinearProfile(max_distance)

Linear distance profile.

Connection probability decreases linearly from 1 at distance 0 to 0 at max_distance.

Parameters:

max_distance (Array | ndarray | bool | number | bool | int | float | complex | Quantity) – Maximum connection distance.

Examples

>>> import numpy as np
>>> import brainunit as u
>>> from braintools.init import LinearProfile
>>>
>>> profile = LinearProfile(max_distance=200.0 * u.um)
>>> distances = np.array([0, 50, 100, 150, 200]) * u.um
>>> probs = profile.probability(distances)

probability(distances)

Calculate connection probability based on distance.

Parameters:

distances (Array | ndarray | bool | number | bool | int | float | complex | Quantity) – Array of distances between neuron pairs.

Returns:

probability – Connection probabilities (values between 0 and 1).

Return type:

ndarray