make_label

Contents

make_label#

pypulseqpp.make_label()[source]#

Create a label event.

Parameters:

  • label (str) – The label’s name, in any spelling. Pulseq’s own names keep their numbering; anything else is minted on first use.

  • type ({'SET', 'INC'}) – 'SET' assigns value, 'INC' adds it to the running counter.

  • value (int or bool or float) – The counter or flag value, taken as an integer.

Returns:

The event, with its fields in slots.

Return type:

LabelEvent

Raises:

ValueError – If type is neither 'SET' nor 'INC'. The name is not checked, which is the point.

Examples

>>> import pypulseqpp as pp
>>> event = pp.make_label("LIN", "SET", 12)
>>> event.type, event.label, event.value
('labelset', 'LIN', 12)

A name Pulseq does not define is accepted and is carried by name:

>>> pp.make_label("SPARKLE", "INC", 1).label
'SPARKLE'
Contents