treams.sw.translate¶
- treams.sw.translate(lambda_, mu, pol, l, m, qol, kr, theta, phi, helicity=True, singular=True)¶
Translation coefficient for spherical modes.
Returns the correct translation coefficient from
treams.special.tl_vsw_A()
,treams.special.tl_vsw_B()
,treams.special.tl_vsw_rA()
, andtreams.special.tl_vsw_rB()
or a combination thereof for the specified mode and basis.The polarization values 0 and 1 refer to negative and positive helicity waves or, if
helicity == False
, to TE and TM parity.- Parameters:
lambda (int, array_like) – Degree of the destination mode
mu (int, array_like) – Order of the destination mode
pol (int, array_like) – Polarization of the destination mode
l (int, array_like) – Degree of the source mode
m (int, array_like) – Order of the source mode
qol (int, array_like) – Polarization of the source mode
kr (float or complex, array_like) – Translation distance in units of the wave number
theta (float, array_like) – Polar angle
phi (float, array_like) – Azimuthal angle
helicity (bool, optional) – If true, helicity basis is assumed, else parity basis. Defaults to
True
.singular (bool, optional) – If true, singular translation coefficients are used, else regular coefficients. Defaults to
True
.
- Returns:
complex