Protocols
MPIMeasurements.ContinousMeasurementProtocolParams — TypeParameters for the ContinousMeasurementProtocol`
fgFrames: Foreground frames to measure. Overwrites sequence framesbgFrames: Background frames to measure. Overwrites sequence framespause: Pause between measurementscontrolTx: If set the tx amplitude and phase will be set with control stepsmeasureBackground: If unset no background measurement will be takensequence: Sequence to measure
MPIMeasurements.MPIForceProtocolParams — TypeParameters for the MPIForceProtocol
controlTx: If set the tx amplitude and phase will be set with control stepssequence: Sequence to measure
MPIMeasurements.MPIMeasurementProtocolParams — TypeParameters for the MPIMeasurementProtocol
fgFrames: Foreground frames to measure. Overwrites sequence framesbgFrames: Background frames to measure. Overwrites sequence framescontrolTx: If set the tx amplitude and phase will be set with control stepsmeasureBackground: If unset no background measurement will be takensaveTemperatureData: If the temperature should be safed or notsequence: Sequence to measurereuseLastBGMeas: Do not measure background but reuse the last BG measurement if suitable
MPIMeasurements.MPSMeasurementProtocolParams — TypeParameters for the MPSMeasurementProtocol
fgFrames: Foreground frames to measure. Overwrites sequence framesbgFrames: Background frames to measure. Overwrites sequence framescontrolTx: If set the tx amplitude and phase will be set with control stepsmeasureBackground: If unset no background measurement will be takenrememberBGMeas: Remember background measurementsaveTemperatureData: If the temperature should be saved or notsequence: Sequence to measuresortPatches: Sort patchessaveInCalibFolder: Flag if the measurement should be saved as a system matrix or notdfPeriodsPerOffset: Number of periods per offset of the MPS offset measurement. Overwrites parts of the sequence definition.averagePeriodsPerOffset: If true all periods per offset are averaged
MPIMeasurements.MechanicalMPIMeasurementProtocolParams — TypeParameters for the MechanicalMPIMeasurementProtocol
fgFrames: Foreground frames to measure. Overwrites sequence framesbgFrames: Background frames to measure. Overwrites sequence framescontrolTx: If set the tx amplitude and phase will be set with control stepsmeasureBackground: If unset no background measurement will be takensaveTemperatureData: If the temperature should be safed or notsequence: Sequence to measurerememberBGMeas: Remember background measurement
MPIMeasurements.MultiSequenceSystemMatrixProtocolParams — TypeParameters for the MultiSequenceSystemMatrixProtocol
controlTx: If set the tx amplitude and phase will be set with control stepssaveTemperatureData: If the temperature should be safed or notsequences: Sequences to measurepositions: SM Positions mapped to the natural sorting of sequence tomlssaveInCalibFolder: Flag if the calibration should be saved as a system matrix or notwaitTime: Seconds to wait between measurementscoolDownTo: Maximum temperature the coils can be at to start the next measurementbgSequence: Sequence to use as a BG measurementnumBGMeas: Number of BG measurements before and after the measurement
MPIMeasurements.RobotBasedMagneticFieldStaticProtocolParams — TypeParameter for the RobotBasedMagneticFieldStaticProtocol
sequencepositionsdescription
MPIMeasurements.RobotBasedSystemMatrixProtocolParams — TypeParameters for the RobotBasedSystemMatrixProtocol
waitTime: Minimum wait time between robot movementsbgFrames: Number of background frames to measure for a background positionfgFrames: Number of frames that are averaged for a foreground positionsaveAsSystemMatrix: Flag if the calibration should be saved as a system matrix or notsaveTemperatureData: Flag if the temperature measured after every robot measurement should be stored in the MDF or notbgMeas: Number of background measurements to takecontrolTx: If set the tx amplitude and phase will be set with control stepssequence: Sequence used for the calibration at each positionpositions
MPIMeasurements.RobotBasedTDesignFieldProtocolParams — TypeParameters for the RobotBasedTDesignFieldProtocol
sequenceradiuscenterNT
MPIMeasurements.RobotMPIMeasurementProtocolParams — TypeParameters for the RobotMPIMeasurementProtocol
fgPos: Foreground positionfgFrames: Foreground frames to measure. Overwrites sequence framesbgFrames: Background frames to measure. Overwrites sequence framescontrolTx: If set the tx amplitude and phase will be set with control stepsmeasureBackground: If unset no background measurement will be takensaveTemperatureData: If the temperature should be safed or notsequence: Sequence to measurerememberBGMeas: Remember background measurement