MtPreparation

Contents

MtPreparation#

class pypulseqpp.sequences.MtPreparation[source]#

Bases: OffResonanceSaturation

Off-resonance SLR saturation followed by an optional spoiler.

Parameters:
  • system (pypulseqpp.Opts) – System limits.

  • flip_angle_deg (float, default=500.0) – Flip angle (degrees); the large value sets the saturation power.

  • freq_offset_hz (float, default=-1500.0) – Offset from water (Hz); nonzero.

  • duration_s (float, default=0.008) – Pulse duration (s).

  • time_bw_product (float, default=4.0) – Time-bandwidth product; with duration_s it sets the width of the saturated band.

  • n_pulses (int, default=1) – Pulses in the train.

  • spoiling_cycles (float, default=4.0) – Cycles of dephasing of the closing spoiler across voxel_size_m. Zero omits the spoiler, for a pulse used for its phase effect.

  • voxel_size_m (float, default=0.001) – Length the dephasing is counted over (m).

  • labels (sequence of str, default=None) – Labels set to 0 on the first pulse’s block, to be changed per shot by the caller.

Attributes:
  • rf_prep (RfEvent) – The pulse, published once however many times it is played.

  • gx_spoil, gy_spoil, gz_spoil (GradEvent) – Spoiler gradient of each axis; absent when spoiling_cycles is zero.

  • prep_labels (LabelSetEvent or list of LabelSetEvent) – One per name in labels.

Raises:

ValueError – If freq_offset_hz is zero, or duration_s or time_bw_product is not positive. If n_pulses is below one, or a spoiling argument is out of range.

Examples

>>> import pypulseqpp.sequences as design
>>> import pypulseqpp as pp
>>> mt = design.MtPreparation(pp.Opts())
>>> len(mt.blocks), round(float(mt.rf_prep.freq_offset))
(2, -1500)

One band below resonance, with the free pool at zero offset not directly saturated:

../_images/pypulseqpp-sequences-MtPreparation-1_00.svg

(svg)#

../_images/pypulseqpp-sequences-MtPreparation-1_01.svg

(svg)#

Methods

init_module

Build the module's block layout; implemented by the subclass.

publish

Publish events from the caller's locals and register keyword aliases.

register

Publish named events, whether or not they were added to a block.

sim_rf

Simulate this module's pulse across off-resonance.

Attributes

blocks

Block tuples in play order, holding the original event objects.

duration

Duration of the module (s).

seq

Sequence holding the module's construction-time block layout.