exponential

Contents

exponential#

class brainpy.state.spatial.exponential(x=spatial.distance, beta=1.0)[source]#

Exponential distance-dependent connection probability.

Returns a callable p(d) = exp(-d / beta) matching NEST’s nest.spatial_distributions.exponential(distance, beta).

Parameters:
  • x (object, optional) – The distance sentinel (or a per-axis expression such as distance.x).

  • beta (float or Quantity, optional) – Decay length; bare floats are taken in micrometres. Default 1.

Returns:

p(d) mapping a distance (Quantity) to a connection probability.

Return type:

callable

Examples

>>> from brainpy import state as bp
>>> import brainunit as u
>>> p = bp.spatial.exponential(bp.spatial.distance, beta=2.0)
>>> float(u.get_magnitude(p(0.0 * u.um)))
1.0