SpiralStackReadout#
- class pypulseqpp.sequences.SpiralStackReadout[source]#
Bases:
NonCartesianReadoutSpiral arms in-plane, Cartesian partitions along z.
- 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. Only on an axis the shot rotation leaves unchanged.fov (float) – Isotropic field of view (m).
matrix (int) – In-plane matrix size.
design_interleaves (int, default=16) – Interleaf count the spiral pitch is designed for, not the number of arms acquired.
direction ({'outward', 'inward', 'in_out'}, default='outward') – Traversal from centre to edge, from edge to centre, or from edge through the centre to edge.
density ({'constant', 'variable', 'dual'}, default='constant') – Pitch constant, rising as a power of the radius, or changing between two plateaus by a logistic transition.
inner_design_interleaves (float, default=None) – Local interleaf count at the centre; defaults to
design_interleaves.outer_design_interleaves (float, default=None) – Local interleaf count at the edge; defaults to twice the inner count for variable density, and is required for dual density.
variable_density_power (float, default=2.0) – Exponent of the normalised radius, for variable density.
transition_radius (float, default=0.5) – Normalised radius, in (0, 1), at which a dual-density spiral changes pitch.
transition_speed (float, default=12.0) – Logistic rate per unit normalised radius of that change.
oversampling (float, default=1.0) – ADC oversampling, at least 1.
readout_bandwidth_hz (float, default=250000.0) – Requested ADC sampling rate (Hz); not the bandwidth per pixel.
n_points (int, default=1024) – Path samples given to the solver, not ADC samples.
derate (bool, default=True) – Apply the package’s system derates before solving.
fov_z (float, default=None) – Partition field of view (m). Stacks only.
matrix_z (int, default=None) – Partition count. Stacks only.
te (float, default=None) – Echo time (s), from the RF centre to the point of the path nearest k = 0.
Noneis as short as possible.tr (float, default=None) – Repetition time (s).
Noneis as short as possible.spoiling_cycles (float, default=0.0) – Cycles of dephasing across
voxel_size_mleft at the end of the TR. Zero leaves the path rewound.voxel_size_m (float, default=None) – Length the spoiling is counted over (m);
Noneis the resolution of the trajectory.spoiling_axis ({'z', 'x', 'y'}, default='z') – Gradient channel of the spoiler.
n_echoes (int, default=1) – Traversals of the path per repetition, joined by rewinders and prewinders, each with its own
ECOlabel.explicit (bool, default=False) – Write out one interleaf per entry of
angles.angles (array_like, default=None) – In-plane interleaf rotations (rad). Required with
explicitand 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 interleaf. Lists with one entry per angle when
explicit.gx_pre, gy_pre (GradEvent) – Prewinding gradients to the start of the path; present when it does not start at k = 0.
gx_rew, gy_rew (GradEvent) – Rewinding gradients to k = 0; present when the path does not end there.
gz_pre, gz_rew (TrapEvent) – Partition encode and its rewinder. Stacks only.
gz_spoil (GradEvent) – End-of-TR spoiler; present when
spoiling_cyclesis nonzero.adc (AdcEvent) – The acquisition window.
adc_labels (LabelSetEvent or list of LabelSetEvent) – One per name in
labels.wait_te, wait_tr (DelayEvent) – Present only when
teortrexceeds the minimum.wait_pre, wait_rew (DelayEvent) – Delays that set the duration of the prewinder and rewinder blocks, which can outlast their gradients; absent when the block is not played.
trajectory (NonCartesianGradient) – The interleaf, for its k-space path and timings.
echo_time (float) – Echo time from the RF centre to the point of the path nearest k = 0 (s).
echo_spacing (float) – Time between consecutive echoes (s); zero for a single echo.
bandwidth_hz (float) – ADC sampling rate
1 / dwell(Hz).n_samples (int) – ADC samples per traversal.
center_sample (int) – Index of the ADC sample nearest k = 0, clipped to the window.
n_arms (int) – Number of arm layouts: the angles when
explicit, else 1.
- Raises:
ValueError – If a count is out of range,
anglesandexplicitdisagree, orteortris 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") >>> slab = design.SpatialSelectiveExcitation(system, 15.0, 0.12, is_slab=True) >>> readout = design.SpiralStackReadout( ... system, slab.rf, slab.gz, ... fov=0.22, matrix=64, design_interleaves=8, n_points=256, ... fov_z=0.12, matrix_z=16, ... ) >>> readout.gz_pre.channel 'z'
One interleaf of one partition, and the arm it traverses:
Methods
Return the blocks of one arm, as built. |
|
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