finesse.simulations.simulation.BaseSimulation.trace_beam¶
- BaseSimulation.trace_beam(self)¶
Traces the beam through the paths which are dependent upon changing geometric parameter(s).
This method will modify those entries in the
self.trace
C array which were previously determined to have changing beam parameter values.- Returns
- validitybool
True if the tracing was successful, or False if an unstable cavity combination prevented a beam trace from being performed.
- Raises
- ex
BeamTraceException
If the
"unstable_handling"
entry of the associatedModel.sim_trace_config
dict is"abort"
and any unstable cavities were encountered.
- ex