Scanner sequences

A sequence function bound to the entries of the scanner protocol.

A plugin file in the design calls’ plugin directory defines one SequencePlugin subclass. Its app is a function returning sequences, and its protocol maps each key of the interpreter’s parameter table, a ProtocolKey, to an entry naming the argument of the sequence function it sets. Its methods evaluate a request into the protocol the design plays and write the design. Conversion between the UI’s units and the sequence function’s SI arguments, and the rounding of resolved values to the precision of a float32 control variable, are described in Protocol resolution.

Sequence

Object	Description
SequencePlugin	A sequence function bound to the scanner protocol.
Evaluation	The outcome of evaluating a valid protocol: the protocol the design achieves, its scan time, a note and optionally its RF layout.
Protocol	The values of a protocol in the units of the sequence function’s arguments, convertible from and to the wire values.
ScannerSequence	Deprecated name of SequencePlugin.
load_plugin	Import a plugin file and instantiate the sequence plugin it defines.
load_exam	Open the cache of the current exam, given to a design hook as exam.

RF layout

The RF an evaluation states: the RF definitions of a sequence, the instances of one TR in play order and the protocol entry each instance’s amplitude follows (Protocol resolution).

Object	Description
RfLayout	The RF definitions a plugin plays and the instances of one TR, each with the control its amplitude follows.
RfControl	A control an RF amplitude follows: the flip angle or a float user entry.

UI entries

Object	Description
TimeParam	Time entry in integer microseconds, bound to an argument in seconds, with presets.
FloatParam	Float entry, bound to an argument scaled from the UI unit.
IntParam	Integer entry.
BoolParam	Checkbox.
ChoiceParam	Choice among the members of a StrEnum; the argument receives the member.
StringListParam	Deprecated: a ChoiceParam over an enum built from option strings.
ConfigParam	Value declared to the interpreter; not shown or edited.
Description	Read-only text row.