finesse.solutions.beamtrace.PropagationSolution.print_distances_matrix

PropagationSolution.print_distances_matrix(scale=1, ztype='geometric', tablefmt='fancy_grid', subs=None)

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

Note that all distances are in metres by default. You can apply a scaling factor, via the scale argument, to all values to change the units accordingly.

Parameters

ztype : str, optional; default: “geometric:

See PropagationSolution.compute_distances_matrix().

scale : float, optional

Scaling factor to apply to distances. Defaults to unity such that all distances are in metres.

tablefmt : str, optional; default: “fancy_grid”

The plain-text table format to pass to tabulate.

subs : dict, 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.