finesse.knm.zero_tem00_phase

finesse.knm.zero_tem00_phase(const double complex[:, ::1] knm_mat, double complex[:, ::1] out=None)

Rotates all coupling coefficients in the matrix knm_mat by the phase of the \(k_{0000}\) coupling coefficient.

Parameters

knm_mat : contiguous array

The matrix of coupling coefficients.

out : contiguous array, optional

Optional matrix in which store the computed results. If not specified then a new numpy.ndarray is returned.

Returns

knm_matrix : numpy.ndarray

The matrix of coupling coefficient values, with phases modified, as a numpy array. If out is specified then this array object is returned.