finesse.solutions.beamtrace.PropagationSolution.distances_matrix_table

PropagationSolution.distances_matrix_table(ztype='geometric', subs=None, numfmt=None, **kwargs)

Returns the distances between each optic, relative to each other, in a table.

Parameters

ztypestr, optional; default: “geometric”:

See PropagationSolution.compute_distances_matrix().

subsdict, optional

A dictionary of model parameter to value substitutions to pass to the eval methods of symbolic expressions.

If this solution object is not symbolic then this argument is ignored.

numfmtstr or func, optional

Either a function to format numbers or a formatting string. The function must return a string. Defaults to using an SI scale function.

**kwargsdict, optional

Additional arguments to create the table. See finesse.utilities.tables.NumberTable for further documentation. The arguments table, colnames and rownames are already used and should not be passed.