MagneticField

Namespace: Endorphin.Instrument.Twickenham.MagnetController
Parent Module: Output

Functions related to the magnetic field of the magnet attached to the the magnet controller.

Functions and values

Function or value	Description
`digitise` Signature: MagnetController -> decimal<MeasureProduct<T,MeasureOne>> -> decimal<MeasureProduct<T,MeasureOne>>	Returns the nearest digitised magnetic field value for the magnet controller.
`fromCurrent` Signature: MagnetController -> CurrentDirection * decimal<MeasureProduct<A,MeasureOne>> -> decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field corresponding to the specified current direction and output current for the magnet controller.
`fromShuntVoltage` Signature: MagnetController -> CurrentDirection * decimal<MeasureProduct<V,MeasureOne>> -> decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field corresponding to the specified current direction and monitoring shunt voltage readout for the magnet controller.
`fromStepIndex` Signature: MagnetController -> CurrentDirection * uint16 -> decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field corresponding to the specified current direction and digital output step index for the magnet controller.
`linearCoefficient` Signature: MagnetController -> decimal<MeasureProduct<MeasureInverse<A>,MeasureProduct<T,MeasureOne>>>	Returns the calibration constant for magnetic field per unit output current for the magnet controller.
`lowerLimit magnetController` Signature: magnetController:MagnetController -> decimal<MeasureProduct<T,MeasureOne>>	Returns the minimum magnetic field value which can be reached by the magnet controller, when the generated magnetic field is opposing the static field and the current is at the software-defined current limit.
`range magnetController` Signature: magnetController:MagnetController -> decimal<MeasureProduct<T,MeasureOne>> * decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field range which can be reached by the magnet controller within the software-defined current limit.
`staticField` Signature: MagnetController -> decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field corresponding to zero output current.
`step` Signature: MagnetController -> decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field difference between digital output steps of the magnet controller.
`toCurrent` Signature: MagnetController -> decimal<MeasureProduct<T,MeasureOne>> -> CurrentDirection * decimal<MeasureProduct<A,MeasureOne>>	Returns the current direction and output current corresponding to the specified magnetic field for the magnet controller.
`toShuntVoltage` Signature: MagnetController -> decimal<MeasureProduct<T,MeasureOne>> -> CurrentDirection * decimal<MeasureProduct<V,MeasureOne>>	Returns the current direction and monitoring shunt voltage readout corresponding to the specified magnetic field for the magnet controller.
`toStepIndex` Signature: MagnetController -> decimal<MeasureProduct<T,MeasureOne>> -> CurrentDirection * uint16	Returns the current direction and digital output step index corresponding to the specified mangetic field for the magnet controller.
`upperLimit magnetController` Signature: magnetController:MagnetController -> decimal<MeasureProduct<T,MeasureOne>>	Returns the maximum magnetic field value which can be reached by the magnet controller, when the generated magnetic field is alligned with the static field and the current is at the software-defined current limit.