finesse.knm.tools.make_scatter_matrix

finesse.knm.tools.make_scatter_matrix(mtype, *args, **kwargs)

Constructs and computes a coupling coefficient scattering matrix of the specified type (via mtype).

Parameters

mtype : str

Type of scattering matrix to compute.

The valid options are:

• “bayerhelms” — computes a Bayer-Helms scattering matrix,

  see make_bayerhelms_matrix().

*args : positional arguments

The positional arguments to pass to the relevant scatter matrix function.

**kwargs : keyword arguments

The keyword arguments to pass to the relevant scatter matrix function.

Returns

kmat : KnmMatrix

The resulting scattering matrix as a KnmMatrix object.

Examples

See Computing arbitrary scattering matrices.