finesse.analysis.actions.locks.SetLockGains
¶
Overview
- class finesse.analysis.actions.locks.SetLockGains(*locks, d_dof_gain=1e-10, gain_scale=1, name='set gains', optimize_phase=None)[source]¶
Bases:
Action
An action that computes the optimal lock gains using the sensing matrix found with
SensingMatrixDC
. This action computes the error signal gradient for each lock with respect to its drive and sets the gain as -gain_scale/sensing.- Parameters
- *lockslist, optional
A list of locks for which to set the gain. If none provided, all enabled locks in model are used. Disabled locks that are explicitly listed will have their gains set.
- d_dof_gainfloat, optional
Step size to use when calculating the gain for each error signal/DOF pair.
- gain_scalefloat, optional
Extra gain scaling factor applied to the gain calculation: -gain_scale/sensing In multiple lock models where the locks are cross coupled using a gain_scale < 1 can improve the stability of the locking algorithm to stop excessively large steps.
- optimize_phasebool, optional,
Deprecated feature: Use
OptimiseRFReadoutPhaseDC
instead- namestr
Name of the action.