ZteReadout#
- class pypulseqpp.sequences.ZteReadout[source]#
Bases:
SequenceModuleContinuous-gradient ZTE shell, including its initial and final ramps.
Each view excites on a held gradient, then acquires while the gradient slews toward the next direction. The final view ramps to zero. A generated shell is replayed under
shot_rotations; the views are not to be rotated individually as well.Transmit ringdown and receiver dead time leave
n_missingcentral samples unacquired; the module reports them and does not fill them. A longer TR lengthens the slew between views instead of adding a delay.- Parameters:
system (pypulseqpp.Opts) – System limits.
rf (RfEvent) – A non-selective pulse, short enough that its bandwidth spans the spoke.
fov (float) – Isotropic field of view (m).
matrix (int) – Isotropic matrix size.
directions (array_like, default=None) – Unit spoke directions
(n_views, 3), in the order the shell visits them. When given,n_views,n_shotsandschemeare ignored and the shell is not replayed. Every turn is allotted the duration of the widest step, so the TR is set by the largest step.n_views (int, default=None) – Spokes in one shell.
Nonesplits a Nyquist-matched sphere ofceil(pi * matrix ** 2)spokes evenly between the shots, so a largern_shotsshortens the shell.n_shots (int, default=None) – Shells the sphere is split into, each the shell turned about z by
2 * pi / n_shotsrelative to the previous one. Playing only some of the shots undersamples in angle.Noneisceil(pi * (matrix - 1)).scheme ({'spiral', 'quiet', 'meridian'}, default='spiral') – Shape of the shell, as in
pypulseqpp.calc_projection_shell().oversampling (float, default=2.0) – Radial oversampling: the k-space sample spacing along the spoke is
1 / (oversampling * fov).readout_bandwidth_hz (float, default=62500.0) – Requested ADC sampling rate (Hz);
bandwidth_hzis the rate achieved on the ADC raster. It also sets the gradient amplitude, one sample perdelta_k.tr (float, default=None) – Pulse centre to pulse centre (s).
Noneis as short as the widest turn allows; a longer TR slows the turns.dead_time_s (float, default=None) – Receiver dead time after the pulse (s), at least
system.adc_dead_time(the default); the transmit ringdown is added to it.labels (sequence of str, default=None) – Labels set to 0 on the acquisition block, to be changed per shot by the caller.
- Attributes:
rf (RfEvent) – The pulse, delayed by the transmit dead time. It is non-selective and short, because it plays on a gradient and its bandwidth has to cover the spoke.
g_ramp (list of GradEvent) – Ramp from zero to the first view’s gradient, played once at the head of a shell; one event per axis.
g_hold (list of list of GradEvent) – Per view, the gradient plateau under the pulse, held through the dead-time gap.
g_read (list of list of GradEvent) – Per view, the plateau under the acquisition followed by the turn onto the next view; the last entry slews to zero instead.
adc (AdcEvent) – The acquisition, delayed past the gap.
adc_labels (LabelSetEvent or list of LabelSetEvent) – One per name in
labels.shot_rotations (numpy.ndarray) – Rotations about z
(n_shots, 3, 3)that map the shell onto the spoke directions of each shot. Present only when the module generated the shell, not whendirectionsis supplied.directions (numpy.ndarray) – Unit spoke directions of one shell
(n_views, 3), in play order.step_rad (float) – Widest angle between consecutive views (rad). Every turn is allotted the duration of this step.
tr (float) – Time from pulse centre to pulse centre (s).
view_duration (float) – Duration of the plateaus held for one view, before the turn (s).
n_samples, n_missing, n_nominal (int) – ADC samples acquired, samples lost to the gap, and samples of the full half-spoke.
gap (float) – Time from the pulse centre to the first sample (s).
bandwidth_hz (float) – Achieved ADC sampling rate
1 / dwell(Hz).delta_k (float) – Radial k-space sample spacing (1/m).
kmax (float) – Half-spoke extent (1/m).
gradient_amplitude (float) – Gradient amplitude of a spoke (Hz/m).
- Raises:
ValueError – If a count is out of range, the pulse is too long for the dwell, the dead-time gap covers the whole spoke, two consecutive views coincide,
dead_time_sis belowsystem.adc_dead_time, ortris shorter than the turn needs.
Examples
>>> import pypulseqpp.sequences as design >>> import pypulseqpp as pp >>> system = pp.Opts() >>> hard = design.NonSelectiveExcitation(system, 4.0, duration_s=10e-6) >>> zte = design.ZteReadout( ... system, hard.rf, fov=0.24, matrix=96, n_views=64, n_shots=256 ... ) >>> len(zte.g_read), zte.shot_rotations.shape (64, (256, 3, 3))
>>> zte.n_samples + zte.n_missing == zte.n_nominal True
Methods
Build the module's block layout; implemented by the subclass. |
|
Publish events from the caller's locals and register keyword aliases. |
|
Publish named events, whether or not they were added to a block. |
Attributes