esquilax.utils.space.get_neighbours_offsets

esquilax.utils.space.get_neighbours_offsets(topology: str) → chex.Array

Get offset co-ords of adjacent cells for a given topology

Returns array containing co-ordinate offsets of neighbours for a desired topology.

Parameters:

topology –

Topology of the neighbouring cells, one of:

Returns:

2d array of offsets of neighbours from a central cell (also containing the central cell).

Return type:

chex.Array