free

Contents

free#

class brainpy.state.spatial.free(positions, extent=None, num_dimensions=None)[source]#

Build a free-position layer (NEST nest.spatial.free).

Parameters:
  • positions (array-like or Distribution) – An explicit (n, d) position array, or a brainpy_state._dist.Distribution whose per-coordinate range positions are drawn from at create-time.

  • extent (sequence or Quantity, optional) – Physical bounding box per dimension (its length sets ndim for a distribution).

  • num_dimensions (int, optional) – Number of dimensions when a distribution is given without extent.

Returns:

A concrete layer (explicit array) or a deferred layer (distribution).

Return type:

Layer

Examples

>>> from brainpy import state as bp
>>> layer = bp.spatial.free(bp.dist.Uniform(-0.5, 0.5), extent=[1.5, 1.5, 1.5])
>>> layer.ndim
3