finesse.locks.Lock
¶
Overview
- class finesse.locks.Lock(name, error_signal, feedback, gain, accuracy, *, disabled=False, offset=0)[source]¶
Bases:
ModelElement
A simple lock which computes and applies the feedback to a given parameter using an error signal.
- Parameters:
- namestr
Name of newly created lock.
- error_signalAny
An error signal parameter or an object capable of producing a real-type error signal. This is typically a demodulated
PowerDetector
instance (or the name of the instance).- feedback
Parameter
A parameter of the model to apply the locks’ feedback signal to.
- gainfloat
Control loop gain.
- accuracyfloat
Threshold to decide whether the loop is locked.
- disabledboolean
If true this lock will not run when the RunLocks() action is used. Explicitly specifying the name of the lock will override this setting, e.g. RunLocks(name).
- offsetfloat
An offset that is applied to the error signal before it is used.
Properties
The error signal of the lock. |
|
A handle to the parameter which the feedback signal is applied to. |
|