treams.translate

treams.translate(r, *, basis, k0=None, material=Material(1, 1, 0), modetype=None, poltype=None, where=True)

Translation matrix.

Translate the given basis modes along the translation vector.

Parameters:

• r (array-like) – Translation vector

• basis (BasisSet or tuple) – Basis set, if it is a tuple of two basis sets the output and input modes are taken accordingly, else both sets of modes are the same.

• k0 (float, optional) – Wave number.

• material (Material or tuple, optional) – Material parameters.

• modetype (str, optional) – Wave mode, only used for PlaneWaveBasisByComp.

• poltype (str, optional) – Polarization, see also Polarizations.

• where (array-like, bool, optional) – Only evaluate parts of the translation matrix, the given array must have a shape that matches the output shape.