finesse.knm.matrix.KnmMatrix.plot

KnmMatrix.plot(self, mode='amplitude', log=False, cmap=None, show=True, filename=None)

Plots the coupling coefficient matrix as a color-mesh.

Parameters:

modestr, optional

Specifier for which attribute of the coupling coefficient to plot. This can be one of (‘amplitude’, ‘phase’, ‘real’, ‘imag’). Defaults to ‘amplitude’.

cmapstr, matplotlib colormap, optional

Colormap to use. Defaults to the default colormap loaded in matplotlib.rcParams.

showbool, optional

Whether to show plot or not. Defaults to true.

filenamestr, path, optional

The name of a file to save the figure to. Defaults to None so that no file is saved.

Returns:

figmatplotlib figure

A handle to the figure.