finesse.knm.KnmMatrix

Overview

class finesse.knm.KnmMatrix(ndarray matrix, model, component, unicode kdir=u'')

Higher-Order-Mode (HOM) scattering matrix container. Essentially a wrapper around a 2D NumPy array with methods for conveniently accessing specific couplings and plotting the matrix as a colormesh.

All component coupling coefficient matrices are stored as objects of this type - e.g. the scattering matrix on reflection from the first surface of some mirror M that is part of a model ifo can be accessed with ifo.M.K11. The data attribute of this object then allows direct access to the underlying NumPy array, whilst the modes attribute gives access to a copy of the mode indices used to produce this scattering matrix (i.e. the finesse.model.Model.homs array of the associated model).

Properties

KnmMatrix.component

The component that the scattering matrix belongs to.

Methods

KnmMatrix.__init__()

Constructs a KnmMatrix from a pre-existing array.

KnmMatrix.get()

Retrieves the coupling coefficient corresponding to the key, returning default if this key is invalid.

KnmMatrix.plot()

Plots the coupling coefficient matrix.