BssfpReadout2D

Contents

BssfpReadout2D#

class pypulseqpp.sequences.BssfpReadout2D[source]#

Bases: SequenceModule

Slice-selective balanced SSFP, phase-encoded along y.

fov and matrix take two values, readout first.

Every axis is balanced between consecutive RF centres. The slice rephasers belong to that balance and are built here, so rf and gz come from an excitation built with rephase=False.

The module’s blocks are excitation, acquisition, rewind. The caller plays each shot as the previous shot’s rewind, excitation and acquisition, and writes the transients: the half-flip pulse (rf at half amplitude, opposite in phase to the first excitation) followed by wait_prep with gz_prep in place of the first rewind; and a last rewind block to ramp down.

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

  • rf (RfEvent) – The excitation.

  • gz (GradEvent, default=None) – Its selection gradient without a rephaser, played in the excitation block; None for a hard pulse.

  • fov (float or sequence of float) – Field of view per encoded axis, readout first (m).

  • matrix (int or sequence of int) – Matrix size per encoded axis, readout first.

  • tr (float, default=None) – Repetition time (s). None is as short as possible; a longer TR is added evenly either side of the echo, so TE stays at TR/2.

  • half_flip_prep (bool, default=True) – Build wait_prep for the half-flip preparation. Requires the acquisition block after the echo to be at least as long as the excitation block after the pulse centre. False when the caller ramps the signal in with dummy repetitions.

  • oversampling (float, default=1.0) – Readout oversampling: the sample spacing in k-space is 1 / (oversampling * fov).

  • readout_bandwidth_hz (float, default=250000.0) – Requested ADC sampling rate (Hz); bandwidth_hz is the rate achieved on the ADC and gradient rasters.

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

  • trigger (TriggerEvent or DigitalOutputEvent, default=None) – Event armed on the rewind block.

Attributes:
  • rf (RfEvent) – The excitation, replayed every repetition with the phase and amplitude the loop sets.

  • gz (GradEvent) – Its selection gradient, if one was given.

  • gx, gx_rew (GradEvent) – gx ramps up from zero, prephases and holds the readout plateau to the end of the acquisition block; gx_rew ramps down from the plateau and rewinds the read axis.

  • gy_pre, gy_rew (TrapEvent) – In-plane encode at its largest step, and the same negated, to be scaled per shot.

  • gz_pre, gz_rew (TrapEvent) – Slice rephasers: gz_pre in the acquisition block after the pulse, gz_rew in the rewind block before the next pulse. Absent for a hard pulse.

  • gz_partition, gz_partition_rew (TrapEvent) – Partition encode at its largest step, and the same negated, sharing the window of gz_pre and gz_rew respectively. 3D only.

  • adc (AdcEvent) – The acquisition window, spanning the readout plateau.

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

  • prep_labels, train_labels, end_labels (list of LabelSetEvent) – ONCE set to 1, 0 and 2, for the half-flip block, the block after it and the final rewind.

  • wait_prep (DelayEvent) – Delay after the half-flip block, which places the half-flip pulse half a repetition before the first excitation. Absent with half_flip_prep=False.

  • gz_prep (TrapEvent) – Slice rephaser played with wait_prep: the two rephasers of a repetition in one lobe, so that the slice axis is balanced from the half-flip pulse to the first excitation. None without a selection gradient; absent with half_flip_prep=False.

  • tr, te (float) – Repetition and echo time (s); te is always half of tr.

  • bandwidth_hz (float) – Achieved ADC sampling rate (Hz).

  • n_samples (int) – ADC samples per repetition.

  • delta_kx (float) – K-space sample spacing along the readout (1/m).

  • readout_duration (float) – Duration of the sampling window (s).

Raises:

ValueError – If a size or rate is out of range, the half_flip_prep condition fails, or the requested TR is shorter than the module can achieve.

Examples

>>> import pypulseqpp.sequences as design
>>> import pypulseqpp as pp
>>> system = pp.Opts()
>>> excitation = design.SpatialSelectiveExcitation(
...     system, 40.0, 5e-3, 1e-3, rephase=False
... )
>>> readout = design.BssfpReadout2D(
...     system, excitation.rf, excitation.gz,
...     fov=(0.28, 0.28), matrix=(64, 64), readout_bandwidth_hz=50_000,
... )
>>> readout.te == readout.tr / 2
True

One repetition and the line it reads. The net gradient area on every axis is zero over the repetition, the condition that defines a balanced acquisition:

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

(svg)#

../_images/pypulseqpp-sequences-BssfpReadout2D-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.

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.