Parameters

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

Functions for specifying magnetic field sweep parameters.

Functions and values

Function or value	Description
`create (...)` Signature: currentDirection:CurrentDirection -> initialStepIndex:uint16 -> finalStepIndex:uint16 -> rampRateIndex:int -> FieldSweepParameters	Creates a magnetic field sweep
`currentChange (...)` Signature: magnetController:MagnetController -> parameters:FieldSweepParameters -> decimal<MeasureProduct<A,MeasureOne>>	Returns the difference between initial and final output current in the magnetic field sweep defined by the sweep parameters on the given magnet controller.
`currentDirection parameters` Signature: parameters:FieldSweepParameters -> CurrentDirection	Returns the current direction of the magnetic field sweep parameters.
`duration magnetController parameters` Signature: magnetController:MagnetController -> parameters:FieldSweepParameters -> decimal<MeasureProduct<s,MeasureOne>>	Returns the estimated duration for the magnetic field sweep on the given magnet controller, not including preparation time.
`fieldChange magnetController parameters` Signature: magnetController:MagnetController -> parameters:FieldSweepParameters -> decimal<MeasureProduct<T,MeasureOne>>	Returns the difference between initial and final magnetic field in the sweep defined by the sweep parameters on the given magnet controller.
`finalCurrent magnetController` Signature: magnetController:MagnetController -> FieldSweepParameters -> decimal<MeasureProduct<A,MeasureOne>>	Returns the final output current corresponding to the magnetic field sweep parameters on the given magnet controller.
`finalField magnetController parameters` Signature: magnetController:MagnetController -> parameters:FieldSweepParameters -> decimal<MeasureProduct<T,MeasureOne>>	Returns the final magnetic field corresponding to the magnetic field sweep parameters on the given magnet controller.
`finalShuntVoltage magnetController` Signature: magnetController:MagnetController -> FieldSweepParameters -> decimal<MeasureProduct<V,MeasureOne>>	Returns the final monitoring shunt voltage corresponding to the magnetic field sweep parameters on the given magnet controller.
`finalStepIndex parameters` Signature: parameters:FieldSweepParameters -> uint16	Returns the final digital output step index of the magnetic field sweep parameters.
`initialCurrent magnetController` Signature: magnetController:MagnetController -> FieldSweepParameters -> decimal<MeasureProduct<A,MeasureOne>>	Returns the initial output current corresponding to the magnetic field sweep parameters on the given magnet controller.
`initialField magnetController parameters` Signature: magnetController:MagnetController -> parameters:FieldSweepParameters -> decimal<MeasureProduct<T,MeasureOne>>	Returns the initial magnetic field corresponding to the magnetic field sweep parameters on the given magnet controller.
`initialShuntVoltage magnetController` Signature: magnetController:MagnetController -> FieldSweepParameters -> decimal<MeasureProduct<V,MeasureOne>>	Returns the initial monitoring shunt voltage corresponding to the magnetic field sweep parameters on the given magnet controller.
`initialStepIndex parameters` Signature: parameters:FieldSweepParameters -> uint16	Returns the initial digital output step index of the magnetic field sweep parameters.
`numberOfSteps parameters` Signature: parameters:FieldSweepParameters -> uint16	Returns the number of digital output steps in the magnetic field sweep defined by the given sweep parameters.
`rampRate magnetController` Signature: magnetController:MagnetController -> FieldSweepParameters -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>>	Returns the ramp rate used while ramping the magnet controller between the initial and final ramp targets for the sweep defined by the given parameters. Note that the maximum available ramp rate on the magnet controller is used while preparing the sweep.
`rampRateIndex target` Signature: target:FieldSweepParameters -> int	Returns the ramp rate index used while ramping the magnet controller between the initial and final ramp targets for the sweep defined by the given parameters. Note that the maximum available ramp rate on the magnet controller is used while preparing the sweep.
`withRampRate rampRateIndex parameters` Signature: rampRateIndex:int -> parameters:FieldSweepParameters -> FieldSweepParameters	Returns modified magnetic field sweep parameters with the specified ramp rate index.