finesse.analysis.actions.sensing.CheckLinearity

Overview

class finesse.analysis.actions.sensing.CheckLinearity(*locks, num_points=10, plot_results=True, xlim=None, name='run locks')[source]

Bases: Action

An action that shows the relationships between all DOFs and all error signals, to check whether they are related linearly. Plotted for DOFs starting at their initial values and up until their initial values + 2*gain*intial error signal.

Parameters:
*lockslist, optional

A list of locks to use in each RunLocks step. Acts like *locks parameter in RunLocks: if not provided, all locks in model are used.

num_pointsint

Number of points to plot in the DOF range.

plot_resultsboolean

Whether or not to plot results (requires matplotlib)

xlimlist or None

Defines (half of) the range of DOF values over which to plot the error signals. If not specified, gains are used to find a useful range of DOF values to plot over.

namestr

Name of the action.