finesse.components.trace_dependency module

Base class for dependencies of beam tracing routines.

class finesse.components.trace_dependency.TraceDependency(*args, **kwargs)

Bases: ModelElement

Base for classes which are dependency objects of beam tracing.

Both Cavity and Gauss inherit from this class.

Parameters

namestr

Name of newly created trace dependency.

prioritynumber, optional; default: 0

Priority value for beam tracing. See TraceDependency.priority.

make_final()

Give this trace dependency the lowest priority in the model.

Internally this will set the priority of this dependency to the current lowest priority in the model minus one.

property priority

The priority value of the dependency.

Larger values indicate higher priority for beam tracing. The list Model.trace_order is sorted in descending order of trace dependency priority values. Dependencies with equal priority values will be ordered alphabetically by their names.

Getter:

Returns the priority value.

Setter:

Sets the priority value and re-sorts the associated Model.trace_order accordingly.

take_priority()

Give this trace dependency the highest priority in the model.

Internally this will set the priority of this dependency to the current highest priority in the model plus one.