SpiralNavigator

Contents

SpiralNavigator#

class pypulseqpp.sequences.SpiralNavigator[source]#

Bases: SequenceModule

Three orthogonal thick-slab spiral navigators.

One excitation and readout are played under axial, sagittal and coronal rotations. The blocks that acquire set the NAV label to 1, and a final block sets it to 0. The navigator excitations perturb the longitudinal magnetisation of the host sequence.

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

  • fov (float, default=0.32) – In-plane field of view (m).

  • matrix (int, default=32) – In-plane matrix size, at least 8.

  • thickness_m (float, default=0.01) – Slab thickness (m).

  • flip_angle_deg (float, default=8.0) – Flip angle (degrees).

  • duration_s (float, default=0.001) – Excitation pulse duration (s).

  • readout_bandwidth_hz (float, default=250000.0) – Requested ADC sampling rate (Hz).

  • navigator_tr (float, default=None) – Repetition time of one three-plane navigator (s). None plays the planes back to back; otherwise each plane is padded to a third of it.

  • spoiling_cycles (float, default=4.0) – Cycles of spoiler dephasing at the end of each plane, across the spiral’s resolution.

Attributes:
  • excitation (SpatialSelectiveExcitation) – The pulse every plane is opened by.

  • readout (SpiralReadout2D) – The designed interleaf every plane plays.

  • rotations (dict) – Rotation applied to the blocks of each plane (None for axial), keyed by plane name.

  • plane_duration (float) – Duration of one plane (s).

Examples

The three planes are one designed arm under three rotations, so the module stores one waveform regardless of the number of planes played:

>>> import pypulseqpp.sequences as design
>>> import pypulseqpp as pp
>>> system = pp.Opts(max_grad=40, grad_unit="mT/m",
...                  max_slew=150, slew_unit="T/m/s")
>>> navigator = design.SpiralNavigator(system)
>>> sorted(navigator.rotations)
['axial', 'coronal', 'sagittal']
>>> navigator.readout.adc.num_samples > 0
True

The navigator repetition, and the spiral its ADC event samples:

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

(svg)#

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

(svg)#

Methods

fit

Return the number of navigators that fit in a time window.

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.