acoustotreams.spw.permute_xyz

acoustotreams.spw.permute_xyz(kx, ky, kz, inverse=False)[source]

Change the coordinate system of the plane-wave basis.

A plane wave in the coordinate system \((x, y, z)\) with the primary direction of propagation along the z-axis is described in the system \((x', y', z') = (y, z, x)\). The inverse transformation is also possible.

The function is essentially diagonal relative to the wavenumber, because we always describe the input and output modes in the unprimed coordinate system.

Parameters:

  • kx (float or array_like) – X-component of the wave vector.

  • ky (float or array_like) – Y-component of the wave vector.

  • kz (float or complex or array_like) – Z-component of the wave vector.

  • inverse (bool, optional) – Defaults to False. If True, use the inverse transformation.

Returns:

complex or array_like