make_label#
- pypulseqpp.make_label()[source]#
Construct a label event.
- Parameters:
label (str) – Label name. Pulseq’s builtin names keep their reference numbering; any other name is registered as a custom label on first use.
type ({'SET', 'INC'}) –
'SET'assignsvalueto the label,'INC'adds it to the label’s running value.value (int or bool or float) – Value to assign or add, converted to an integer.
- Returns:
The compiled label event.
- Return type:
LabelEvent
- Raises:
ValueError – If
typeis neither'SET'nor'INC', orlabelis empty. The name is not checked against Pulseq’s builtin labels.
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 a custom label, carried by name:
>>> pp.make_label("SPARKLE", "INC", 1).label 'SPARKLE'