Sequence.get_default_soft_delay_values

Sequence.get_default_soft_delay_values#

Sequence.get_default_soft_delay_values()[source]#

Return each soft delay’s default value.

The default is the value (duration - offset) * factor that reproduces the duration a block was built with; blocks sharing a numeric id have to agree on it.

Returns:

  • defaults (dict[str, float]) – The default value of each soft delay, by its hint.

  • error_report (list[str]) – One line per inconsistency found; empty when there is none.

  • limits (list[dict | None]) – Per numeric id, None if unused, else a dict with the default ('def'), the hint ('hint'), the first block it was derived from ('blk') and the range of values that keep the block duration non-negative ('min', 'max').

Raises:

ValueError – If two numeric ids carry the same hint.

Warns:

UserWarning – If the numeric ids are not contiguous.

Examples

>>> import pypulseqpp as pp
>>> seq = pp.Sequence(pp.Opts())
>>> seq.add_block(pp.make_delay(1e-3), pp.make_soft_delay("TE", numID=0))
1
>>> defaults, error_report, limits = seq.get_default_soft_delay_values()
>>> defaults, error_report
({'TE': 0.001}, [])