finesse.tracing.tools.compute_abcd¶

finesse.tracing.tools.compute_abcd(from_node=None, to_node=None, via_node=None, path=None, direction='x', symbolic=False, solution_name=None)[source]¶

Computes the composite ABCD matrix through a given path.

By setting the argument symbolic to true, this method will return a symbolic representation of the ABCD matrix rather than a numeric matrix.

Parameters

from_node : Node

Node to trace from.

to_node : Node

Node to trace to.

via_node : Node, optional

Optional node to trace via.

path : OpticalPath, optional

A pre-generated path to use (produced from a call to Model.path()).

directon : str, optional; default: “x”

Direction of ABCD matrix computation (can be ‘x’, for tangential plane, or ‘y’, for sagittal plane).

symbolic : bool, optional; default: False

Flag indicating whether to compute a symbolic ABCD matrix.

Returns

out : ABCDSolution

ABCD matrix solution object between the specified nodes.