ProtocolParameter

class pypulseqpp.sequences.ProtocolParameter

Bases: object

One prescribed parameter, as init_sequence declares and documents it.

Attributes

name	The keyword init_sequence takes.
type	The scalar the annotation names, bool, int, float or str; None for any other annotation.
default	The default; inspect.Parameter.empty for a parameter without one.
optional	Whether the annotation admits None, which leaves the value to the design.
unit	The first parenthesised group of the description's first sentence, the form the shipped applications state units in, as in Echo time (s).; empty where there is none.
choices	The values the documented type lists in braces, as in {'slab', 'nonselective'}, in the order listed; empty otherwise.
description	The description in the Parameters section, on one line.