FrequencySelectiveExcitation

FrequencySelectiveExcitation#

class pypulseqpp.sequences.FrequencySelectiveExcitation[source]#

Bases: RfModule

SLR excitation of a spectral band without spatial selection.

The duration is time_bw_product / bandwidth_hz rounded up to the RF raster. The offsets in Hz and in ppm add.

Parameters:
  • system (pypulseqpp.Opts) – System limits.

  • flip_angle_deg (float) – Flip angle (degrees).

  • bandwidth_hz (float) – Spectral passband (Hz).

  • freq_offset_ppm (float, default=0.0) – Centre of the band relative to water (ppm).

  • freq_offset_hz (float, default=0.0) – Centre of the band (Hz), added to freq_offset_ppm.

  • time_bw_product (float, default=4.0) – Time-bandwidth product; a higher value gives a squarer band and a longer pulse.

  • 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 spectral profile.

  • stopband_ripple (float, default=0.01) – Ripple allowed in each band of the spectral profile.

Attributes:
  • rf (RfEvent) – The pulse.

  • duration_s (float) – Pulse length (s), set by the passband.

  • bandwidth_hz (float) – Requested passband (Hz).

Raises:

ValueError – If bandwidth_hz or time_bw_product is not positive.

Examples

>>> import pypulseqpp.sequences as design
>>> import pypulseqpp as pp
>>> water = design.FrequencySelectiveExcitation(pp.Opts(), 90.0, bandwidth_hz=200.0)
>>> len(water.blocks), round(water.duration_s * 1e3, 3)
(1, 20.0)
>>> narrow = design.FrequencySelectiveExcitation(pp.Opts(), 90.0, bandwidth_hz=100.0)
>>> narrow.duration_s == 2 * water.duration_s
True

The envelope and the band it tips. Magnetisation outside the passband stays longitudinal:

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

(svg)#

../_images/pypulseqpp-sequences-FrequencySelectiveExcitation-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.