Masks

ed_lgt.modeling.masks.border_mask(lvals, border, stag_label=None)[source]

This function generate the mask d-dimensional array of booleans corresponding to specific sites on a certain lattice border. Eventually, it can also take into account the staggerization of the lattice, acting only on even or odd sites.

Parameters:
  • lvals (tuple of ints) – lattice size

  • border (str) – one of [mx, px, my, py, mz, pz]

  • stag_label (str, optional) – It can be “even” or “odd”. Defaults to None.

Returns:

mask array of shape=lvals

Return type:

ndarray

ed_lgt.modeling.masks.staggered_mask(lvals, stag_label)[source]

This function provides a d-dimensional array of bools corresponding to the sites of the lattice (of size lvals) that are respectively site=even or site=odd

Parameters:
  • lvals (tuple of ints) – lattice size

  • stag_label (str) – It can be “even” or “odd”

Returns:

mask array of shape=lvals

Return type:

ndarray