SmsExcitation#
- class pypulseqpp.sequences.SmsExcitation[source]#
Bases:
RfModuleSLR slice excitation modulated into simultaneous spectral bands.
The slice spacing is converted to a band spacing in frequency with the selection gradient amplitude. The band phases set the peak B1 of the combined pulse.
- Parameters:
system (pypulseqpp.Opts) – System limits.
flip_angle_deg (float) – Flip angle of each band (degrees).
thickness_m (float) – Slice thickness (m), set by the selection gradient plateau against the single-band pulse’s measured bandwidth.
slice_gap_m (float) – Centre-to-centre spacing between excited slices (m).
n_bands (int, default=2) – Slices excited at once.
duration_s (float, default=0.003) – Pulse duration (s).
phases ({'quadratic'} or sequence of float, default='quadratic') – Phase of each band (rad).
'quadratic'lowers the peak B1;Noneleaves every band in phase, the highest peak.rephase (bool, default=True) – Include the slice rephaser.
time_bw_product (float, default=4.0) – Time-bandwidth product of the single-band pulse.
axis ({'z', 'x', 'y'}, default='z') – Selection axis.
use (str, default='excitation') – Pulseq RF use tag.
- Attributes:
rf (RfEvent) – The modulated pulse.
gz (TrapEvent) – The selection gradient.
gz_reph (TrapEvent) – Its rephaser, only when
rephase=True.band_offsets_hz (numpy.ndarray) – Band frequency offsets (Hz), symmetric about zero.
band_positions_m (numpy.ndarray) – Slice centre positions (m).
peak_ratio (float) – Peak B1 relative to the single-band pulse the bands were made from.
- Raises:
ValueError – If a size is not positive,
n_bandsis below one, oraxisis not a gradient channel.
Examples
>>> import pypulseqpp.sequences as design >>> import pypulseqpp as pp >>> system = pp.Opts(max_grad=40, grad_unit="mT/m", max_slew=180, slew_unit="T/m/s") >>> sms = design.SmsExcitation( ... system, 60.0, thickness_m=3e-3, slice_gap_m=24e-3, n_bands=3 ... ) >>> sms.band_positions_m.round(6).tolist() [-0.024, 0.0, 0.024]
>>> stacked = design.SmsExcitation( ... system, 60.0, thickness_m=3e-3, slice_gap_m=24e-3, n_bands=3, phases=None ... ) >>> round(stacked.peak_ratio, 1), bool(sms.peak_ratio < stacked.peak_ratio) (3.0, True)
Three slices from one pulse, at the gap they were designed for:
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