finesse.knm.flip_odd_horizontal

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

Flips the sign of all odd couplings in the sagittal plane.

Parameters

knm_mat : contiguous array

The matrix of coupling coefficients.

homs : contiguous array

Array of HG modes to compute couplings between, formatted as [(n0, m0), (n1, m1), …].

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 flipped values, as a numpy array. If out is specified then this array object is returned.