RosetteReadout2D#
- class pypulseqpp.sequences.RosetteReadout2D[source]#
Bases:
NonCartesianReadoutOne multi-petal rosette interleaf in a plane.
- 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.
petals (int, default=5) – Centre-to-centre lobes in one interleaf, not shots.
angular_frequency_ratio (float, default=3.0 / 5.0) – Angular over radial frequency, positive.
echo_spacing_s (float, default=None) – Mean centre-to-centre petal duration (s); the waveform is stretched to it.
Noneis the minimum the system limits allow, and a shorter request is rejected.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.
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") >>> excitation = design.SpatialSelectiveExcitation(system, 15.0, 5e-3) >>> readout = design.RosetteReadout2D( ... system, excitation.rf, excitation.gz, excitation.gz_reph, ... fov=0.22, matrix=64, ... ) >>> [gradient.channel for gradient in (readout.gx, readout.gy)] ['x', 'y']
One interleaf, whose petals pass through the centre of k-space once per petal:
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