finesse.components.general.LocalDegreeOfFreedom
Overview
- class finesse.components.general.LocalDegreeOfFreedom(name, DC=None, AC_IN=None, DC_2_AC_scaling=None, AC_OUT=None)[source]
Bases:
objectA local degree of freedom definition that combines a DC parameter and AC nodes at some element. For example, this can pair a mirror tuning and it the AC mechanical nodes into one “Degree of Freedom” that can be referenced to scan, drive, or readout. Some DOFs do not have a DC equivalent so the DC part may be None. A DOF can have a different input (drive) and output (readout) signal node. This is used in more advanced cases such as suspension systems, where you drive some motion through a force/torque actuation on some part of the suspension but the readout is in displacement/rotation of the final optic.
- Parameters:
- namestr
Name should be the full-name of the definition for a particular element, e.g. m1.dofs.z if this is wrong, then unparsing will not work correctly
- DCParameter, optional
The DC equivlent of the AC signal node of an element, setting to None means no DC actuation happens.
- AC_INSignalNode
The node that is driven for this degree of freedom, cannot be None.
- DC_2_AC_scalingfloat, optional
Scaling factor relating the DC and AC parameter and nodes. For example, the scaling between phi (degrees) and mirror.mech.z (meters).
- AC_OUTSignalNode, optional
The node that is read out to describe this degree of freedom, if None there is nothing to readout here.
Properties