finesse.utilities.wigner.wigner_moments_2D_hg

finesse.utilities.wigner.wigner_moments_2D_hg(E, qx, qy, lam=1.064e-06, assume_wigner_matrix_symmetry=True, include_gouy=False)[source]

Function for computing the Wigner moments of a set of HG mode amplitudes in a given basis (qx,qy). This function also computes other useful metrics from the Wigner moments such as the M2 (M-squared) and the Wigner basis of a beam.

Parameters
Earray_like

HG mode coefficient matrix. If you have a 1D array of HG mode amplitudes use the E_1D_to_2D method to convert it first.

qx, qycomplex | finesse.BeamParam

x and y direction complex guassian beam paramters

lamfloat

wavelength of light used

include_gouybool

Include Gouy phase in HG normalisation [experimental]

assume_wigner_matrix_symmetrybool

When True only lower half of the Wigner matrix is calculated

Returns
resultWignerMomentsHG

Collection of calculations outputs from Wigner moment calculations

Notes

It should be noted that the Wigner basis calculation and the M2 values along each axis (m2x, m2y) are only valid in the case where the general astigmatic wigner moments of the beam are close to zero. The general astigmatic components of a wigner distribution are xv, vx, yu, uy and potentially xy, yx, uv, vu (not sure about those).