Parameters

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

Functions for specifying magnetic field target parameters.

Functions and values

Function or value	Description
`create (...)` Signature: currentDirection:CurrentDirection -> stepIndex:uint16 -> rampRateIndex:int -> FieldTargetParameers	Defines magnetic field target parameters.
`current magnetController` Signature: magnetController:MagnetController -> FieldTargetParameers -> decimal<MeasureProduct<A,MeasureOne>>	Returns the output current corresponding to the field target parameters on the given magnet controller.
`currentDirection parameters` Signature: parameters:FieldTargetParameers -> CurrentDirection	Returns the current direction of the given magnetic field target parameters.
`field magnetController parameters` Signature: magnetController:MagnetController -> parameters:FieldTargetParameers -> decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field corresponding to the field target parameters on the given magnet controller.
`rampRate magnetController` Signature: magnetController:MagnetController -> FieldTargetParameers -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>>	Returns the ramp rate corresponding to the magnetic field target parameters on the given magnet controller.
`rampRateIndex parameters` Signature: parameters:FieldTargetParameers -> int	Returns the ramp rate index corresponding to the magnetic field target parameters.
`shuntVoltage magnetController` Signature: magnetController:MagnetController -> FieldTargetParameers -> decimal<MeasureProduct<V,MeasureOne>>	Returns the monitoring shunt voltage readout corresponding to the field target parameters on the given magnet controller.
`stepIndex parameters` Signature: parameters:FieldTargetParameers -> uint16	Returns the digital output step index of the given magnetic field target parameters.
`withRampRateIndex (...)` Signature: rampRateIndex:int -> parameters:FieldTargetParameers -> FieldTargetParameers	Returns modified magnetic field target parameters with the specified ramp rate index.