finesse.gaussian.BeamParam.eval

BeamParam.eval(as_bp=True, subs=None, keep=None)[source]

Evaluate the symbolic beam parameter. Parameter substitutions can be performed via the substitution dict subs.

Note that this simply returns BeamParam.q if this is not symbolic.

Parameters
as_bpbool, optional; default: True

Flag indicating whether to return result as a BeamParam instance.

subsdict, optional; default: None

Dictionary of parameter substitutions.

keepiterable, str

A collection of names of variables to keep as variables when evaluating.