finesse.solutions.beamtrace.PropagationSolution.compute_distances_matrix

PropagationSolution.compute_distances_matrix(ztype='geometric', subs=None)

Compute the distances between each optic, relative to each other.

Returns a dict of dicts for each “delta z”. Note that each distance value is in metres. Use PropagationSolution.distances_matrix_table() to create a tabulated representation of this dict.

Parameters

ztypestr, optional; default: “geometric”

Type of distance, can be either ‘geometric’ or ‘optical’. In the former case the values are the distances between each optic in terms of sums of space lengths of each space between them. In the latter case, each value is instead the optical path length between each component, i.e. the sum of the product of the space length and refractive index of each space between them.

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.

Returns

deltasdict

Dict of dicts for each dz between components.