SequenceApp.parameters

classmethod SequenceApp.parameters()

Return each parameter of init_sequence with its type, default, unit and description.

Returns:

dict of {str – One entry per parameter a prescription names, in signature order.

Return type:

ProtocolParameter}

Examples

>>> from pypulseqpp import sequences
>>> te = sequences.gre2D_sequence.Gre2DApp.parameters()["te"]
>>> te.type, te.default, te.optional, te.unit
(<class 'float'>, 0.008, True, 's')
>>> te.description
'Echo time (s). ``None`` is as short as the readout admits.'