Open
Description
This issue is inspired by #2388. The attached notebook provides a brief overview over some problems with the current implementation and documentation of location-dependent connection kernels, especially the Gaussian variants
Here some suggestions for a solution:
- Around the table of "distributions" in https://github.com/nest/nest-simulator/blob/master/doc/userdoc/guides/spatially_structured_networks.rst, make very explicit that these are not distributions, but functions and that their behavior depends on what they are "fed".
- Very clearly distinguish between distance (Euclidean distance of source and target neuron, non-negative scalar) and displacement, the vector pointing from source neuron to target neuron.
- Similar to
nest.spatial.distance
, introducenest.spatial.displacement
, which will be a 2D or 3D vector. - Users can provide either distance or displacement as input, but they will be explicit then, and we should provide examples for behaviour in both cases.
- Where kernel functions need scalar values while the user provides vectors, we implicitly apply the Euclidean norm to the vector.
- Explicit passing of x- and y-components is reserved for very special cases.
- Rotation of the 2D gaussian is expressed using an angle as in Add rectified Gabor distribution for nest.spatial #2387. The use of
$\rho$ might be kept for backward compatibility for a transition period.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
To do (open issues)