finesse.knm.matrix.KnmMatrix.plot¶

KnmMatrix.plot(self, mode='amplitude', log=False, deg=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’, ‘amplitude/phase’, or ‘real/imag’. Defaults to ‘amplitude’.
logbool, optional: Whether the log of the data should be plotted. This is only used for ‘amplitude’ and is ignored for all other options. Defaults to False.
degbool, optional: Whether the data should be plotted in degrees or radians. This is only used for ‘phase’ and is ignored for all other options. Defaults to False.
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