SpatialSelectiveExcitation#

class pypulseqpp.sequences.SpatialSelectiveExcitation[source]#

Bases: RfModule

SLR excitation with a selection gradient and optional rephasing.

A slice plays gz and gz_reph in two blocks. With is_slab=True the rephaser is merged into gz in one block. rephase=False omits 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 delay already places it on the gradient’s flat top.

  • gz (TrapEvent or GradEvent) – The selection gradient; under is_slab the rephaser is part of it.

  • gz_reph (TrapEvent) – The rephaser. Only when not is_slab and rephase.

  • 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_m to rounding.

  • pulse_duration (float) – Duration the pulse is designed at (s): duration_s, or longer where system.max_b1 requires.

Raises:

ValueError – If thickness_m or duration_s is not positive, or axis is 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:

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

(svg)#

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

(svg)#

Methods

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.

sim_rf

Simulate this module's pulse across off-resonance.

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.

Examples using SpatialSelectiveExcitation#

9. Sequence modules

9. Sequence modules

10. Custom sequence module

10. Custom sequence module

Slice-selective excitation

Slice-selective excitation

Spiral readout

Spiral readout

Ramp-sampled readout

Ramp-sampled readout

Twisting radial readout

Twisting radial readout

Minimum-phase excitation

Minimum-phase excitation