ShuntVoltage

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

Functions related to the monitoring shunt voltage readout of the magnet controller.

Functions and values

Function or value	Description
`digitise` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>> -> decimal<MeasureProduct<V,MeasureOne>>	Returns the nearest digitised monitoring shunt voltage readout.
`fromCurrent` Signature: MagnetController -> decimal<MeasureProduct<A,MeasureOne>> -> decimal<MeasureProduct<V,MeasureOne>>	Returns the monitoring shunt voltage readout corresponding to the specified output current for the magnet controller.
`fromMagneticField` 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.
`fromStepIndex` Signature: MagnetController -> uint16 -> decimal<MeasureProduct<V,MeasureOne>>	Returns the monitoring shunt voltage readout corresponding to the specified digital output step index for the magnet controller.
`linearCoefficient` Signature: MagnetController -> decimal<MeasureProduct<MeasureInverse<A>,MeasureProduct<V,MeasureOne>>>	Returns the calibration constant for monitoring shunt voltage per unit output current.
`maximum` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>>	Returns the shunt voltage readout at maximum output current for the magnet controller.
`offset` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>>	Returns the voltage offset in the monitoring shunt readout at zero current.
`rmsNoise` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>>	Returns the RMS voltage noise level in the monitoring shunt readout.
`step` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>>	Returns the monitoring shunt voltage difference between digital output steps of the magnet controller.
`toCurrent` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>> -> decimal<MeasureProduct<A,MeasureOne>>	Returns the output current corresponding to the specified monitoring shunt voltage readout for the magnet controller.
`toMagneticField` 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.
`toStepIndex` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>> -> uint16	Returns the digitial output step index corresponding to the specified monitoring shunt voltage readout for the magnet controller.