RadialProjectionReadout

RadialProjectionReadout#

class pypulseqpp.sequences.RadialProjectionReadout[source]#

Bases: SequenceModule

Radial spokes for a spherical projection acquisition.

The loop supplies 3D rotations. Partition encoding is not supported.

The ADC samples the plateau. A slice rephaser may share an axis left invariant by the shot rotation. With explicit=True the spokes are written out, one per entry of angles; otherwise the caller rotates one base spoke per shot.

A compact layout holds one base arm, which the caller rotates per shot; an explicit layout holds each rotated arm.

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

  • rf (RfEvent) – Pulse that opens the repetition.

  • gz (GradEvent, default=None) – Selection gradient played with rf.

  • gz_reph (GradEvent, default=None) – Rephaser of gz, left-aligned in the first block after the pulse (the TE wait if there is one, else the prephaser block). Only on an axis the shot rotation leaves unchanged: z for an in-plane acquisition, none for a projection.

  • fov (float) – Isotropic in-plane field of view (m).

  • matrix (int) – In-plane matrix size; sets kmax = matrix / (2 * fov).

  • fov_z (float, int, default=None) – Partition field of view (m) and count. Stacks only.

  • matrix_z (float, int, default=None) – Partition field of view (m) and count. Stacks only.

  • te (float, default=None) – Echo time (s), from the RF centre to the centre crossing of the spoke. None is as short as possible.

  • tr (float, default=None) – Repetition time (s). None is as short as possible.

  • oversampling (float, default=1.0) – Readout oversampling: ADC samples per matrix point along the spoke.

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

  • spoiling_cycles (float, default=0.0) – Cycles of dephasing across voxel_size_m left at the end of the TR. Zero leaves the spoke rewound.

  • voxel_size_m (float, default=None) – Length the spoiling is counted over (m); None is fov / matrix.

  • spoiling_axis ({'z', 'x', 'y'}, default='z') – Gradient channel of the spoiler.

  • n_echoes (int, default=1) – Traversals of the spoke per repetition, each retracing the same k-space coordinates with its own ECO label.

  • explicit (bool, default=False) – Write out one spoke per entry of angles.

  • angles (array_like, default=None) – In-plane spoke rotations (rad). Required with explicit and rejected without it.

  • 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 block that opens the readout.

Attributes:
  • rf (RfEvent) – The pulse the module was given.

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

  • gz_reph (GradEvent) – Its rephaser, if one was given.

  • gx, gy (GradEvent) – The spoke from prephaser through rewinder. gy is the same waveform at zero amplitude, so a rotation always has a y event to fill. Lists with one entry per angle when explicit.

  • gz_pre, gz_rew (TrapEvent) – Partition encode and its rewinder. Stacks only.

  • gz_spoil (GradEvent) – End-of-TR spoiler; present when spoiling_cycles is nonzero.

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

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

  • wait_te, wait_tr (DelayEvent) – Present only when te or tr exceeds the minimum.

  • echo_time (float) – Echo time from the RF centre to the centre crossing (s).

  • echo_spacing (float) – Time between consecutive echoes (s); zero for a single echo.

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

  • n_samples (int) – ADC samples per traversal.

  • center_sample (int) – Index of the ADC sample at the k-space centre.

  • readout_duration (float) – Duration of the readout plateau (s).

  • n_arms (int) – Number of arm layouts: the angles when explicit, else 1.

Raises:

ValueError – If a count is out of range, angles and explicit disagree, or te or tr is shorter than the module can achieve.

Examples

>>> 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")
>>> hard = design.NonSelectiveExcitation(system, 10.0, 0.5e-3)
>>> readout = design.RadialProjectionReadout(
...     system, hard.rf, fov=0.24, matrix=64
... )
>>> int(readout.adc.num_samples) > 0
True

One half-spoke of a spherical projection acquisition, before the loop turns it:

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

(svg)#

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

(svg)#

Methods

arm

Return the blocks of one arm, as built.

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.