skued.minimum_image_distance

skued.minimum_image_distance(xx, yy, zz, lattice)

Returns a periodic array according to the minimum image convention.

Parameters:

  • xx (ndarrays) – Arrays of equal shape, such as produced by numpy.meshgrid.

  • yy (ndarrays) – Arrays of equal shape, such as produced by numpy.meshgrid.

  • zz (ndarrays) – Arrays of equal shape, such as produced by numpy.meshgrid.

  • lattice (list of ndarrays, shape(3,)) – Basis of the mesh

Returns:

r – Minimum image distance over the lattice

Return type:

~numpy.ndarray