SpatialSelectiveExcitation#
- class pypulseqpp.sequences.SpatialSelectiveExcitation[source]#
Bases:
RfModuleSLR excitation with a selection gradient and optional rephasing.
A slice plays
gzandgz_rephin two blocks. Withis_slab=Truethe rephaser is merged intogzin one block.rephase=Falseomits it, for a readout that includes the rephaser’s moment.- Parameters:
system (pypulseqpp.Opts) – System limits.
flip_angle_deg (float) – Flip angle (degrees).
thickness_m (float) – Slice or slab thickness (m), set by the selection gradient plateau against the pulse’s measured bandwidth.
duration_s (float, default=0.003) – Pulse duration (s); lengthened, flip angle and time-bandwidth product held, when the pulse would peak above the derated
system.max_b1.is_slab (bool, default=False) – Merge the rephaser into the selection gradient.
rephase (bool, default=True) – Include the slice rephaser.
time_bw_product (float, default=4.0) – Time-bandwidth product; a higher value gives a squarer profile and a longer pulse at the same bandwidth.
axis ({'z', 'x', 'y'}, default='z') – Selection axis.
pulse_type ({'st', 'ex', 'se', 'inv', 'sat'}, default='st') – SLR design: small-tip, excitation, spin-echo, inversion or saturation.
use (str, default='excitation') – Pulseq RF use tag.
passband_ripple (float, default=0.01) – Ripple allowed in each band of the slice profile.
stopband_ripple (float, default=0.01) – Ripple allowed in each band of the slice profile.
- Attributes:
rf (RfEvent) – The pulse. Its
delayalready places it on the gradient’s flat top.gz (TrapEvent or GradEvent) – The selection gradient; under
is_slabthe rephaser is part of it.gz_reph (TrapEvent) – The rephaser. Only when not
is_slabandrephase.selection_amplitude (float) – Plateau amplitude of the selection lobe (Hz/m), which a slice offset is converted against:
freq_offset = selection_amplitude * position.slice_thickness (float) – The thickness selected (m), the pulse’s measured bandwidth over
selection_amplitude:thickness_mto rounding.pulse_duration (float) – Duration the pulse is designed at (s):
duration_s, or longer wheresystem.max_b1requires.
- Raises:
ValueError – If
thickness_morduration_sis not positive, oraxisis not a gradient channel.
Examples
>>> import pypulseqpp.sequences as design >>> import pypulseqpp as pp >>> slice_ = design.SpatialSelectiveExcitation(pp.Opts(), 15.0, 5e-3) >>> len(slice_.blocks), slice_.gz_reph.channel (2, 'z')
>>> slab = design.SpatialSelectiveExcitation(pp.Opts(), 8.0, 0.12, is_slab=True) >>> len(slab.blocks), slab.gz.type (1, 'grad')
The module diagram and simulated slice profile are generated from the same RF event and selection gradient:
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. |
|
Simulate this module's pulse across off-resonance. |
Attributes
Block tuples in play order, holding the original event objects. |
|
Duration of the module (s). |
|
Sequence holding the module's construction-time block layout. |