Convert

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

Functions related to unit conversions.

Functions and values

Function or value	Description
`currentToMagneticField (...)` Signature: magnetController:Settings -> (currentDirection:CurrentDirection * current:decimal<MeasureProduct<A,MeasureOne>>) -> decimal<MeasureProduct<T,MeasureOne>>	Gives the magnetic field corresponding to the given current direction and current for the magnet controller.
`currentToShuntVoltage (...)` Signature: magnetController:Settings -> current:decimal<MeasureProduct<A,MeasureOne>> -> decimal<MeasureProduct<V,MeasureOne>>	Gives the monitoring shunt voltage readout corresponding to the given current for the magnet controller.
`currentToStepIndex (...)` Signature: magnetController:Settings -> current:decimal<MeasureProduct<A,MeasureOne>> -> uint16	Gives the output step index corresponding to the specified current for the magnet controller.
`magneticFieldToCurrent (...)` Signature: magnetController:Settings -> magneticField:decimal<MeasureProduct<T,MeasureOne>> -> CurrentDirection * decimal<MeasureProduct<A,MeasureOne>>	Gives the current direction and current required to achieve the specified magnetic field for the magnet controller.
`magneticFieldToShuntVoltage (...)` Signature: magnetController:Settings -> magneticField:decimal<MeasureProduct<T,MeasureOne>> -> CurrentDirection * decimal<MeasureProduct<V,MeasureOne>>	Gives the current direction and monitoring shunt voltage readout corresponding to the magnetic field for the magnet controller.
`magneticFieldToStepIndex (...)` Signature: magnetController:Settings -> magneticField:decimal<MeasureProduct<T,MeasureOne>> -> CurrentDirection * uint16	Gives the current direction and output step index corresponding to the specified magnetic field for the magnet controller.
`shuntVoltageToCurrent (...)` Signature: magnetController:Settings -> shuntVoltage:decimal<MeasureProduct<V,MeasureOne>> -> decimal<MeasureProduct<A,MeasureOne>>	Gives the output current corresponding to the given monitoring shunt voltage readout for the magnet controller.
`shuntVoltageToMagneticField (...)` Signature: magnetController:Settings -> (currentDirection:CurrentDirection * shuntVoltage:decimal<MeasureProduct<V,MeasureOne>>) -> decimal<MeasureProduct<T,MeasureOne>>	Gives the mangetic field corresponding to the given current direction and monitoring shunt voltage readout for the magnet controller.
`shuntVoltageToStepIndex (...)` Signature: magnetController:Settings -> shuntVoltage:decimal<MeasureProduct<V,MeasureOne>> -> uint16	Gives the output step index correspondign to the specified monitoring shunt voltage readout for the magnet controller.
`stepIndexToCurrent (...)` Signature: magnetController:Settings -> index:uint16 -> decimal<MeasureProduct<A,MeasureOne>>	Gives the current corresponding to the specified digital step indeex for the magnet controller.
`stepIndexToMagneticField (...)` Signature: magnetController:Settings -> (currentDirection:CurrentDirection * index:uint16) -> decimal<MeasureProduct<T,MeasureOne>>	Gives the magnetic field corresponding to the given current direction and output step index for the magnet controller.
`stepIndexToShuntVoltage (...)` Signature: magnetController:Settings -> index:uint16 -> decimal<MeasureProduct<V,MeasureOne>>	Gives the monitoring shunt voltage readout corresponding to the given output step index for the magnet controller.