FatSaturation#
- class pypulseqpp.sequences.FatSaturation[source]#
Bases:
RfModuleSpectrally selective fat saturation of the whole transmit volume, with a three-axis spoiler.
The pulse plays with no gradient, so a field-of-view offset or rotation applied afterwards does not change it.
- Parameters:
system (pypulseqpp.Opts) – System limits.
freq_offset_ppm (float, default=FAT_SHIFT_PPM) – Fat offset from water (ppm), carried on the pulse as a ppm offset, which an interpreter resolves against the field of the scan.
flip_angle_deg (float, default=110.0) – Saturation flip angle (degrees).
bandwidth_hz (float, default=250.0) – Spectral passband (Hz); the pulse duration is
time_bw_product / bandwidth_hz.time_bw_product (float, default=2.0) – Time-bandwidth product.
spoiling_cycles (float, default=4.0) – Cycles of dephasing of each spoiler across
voxel_size_m.voxel_size_m (float, default=0.001) – Length the dephasing is counted over (m).
- Attributes:
rf_prep (RfEvent) – The saturation pulse.
gx_spoil, gy_spoil, gz_spoil (GradEvent) – Spoiler gradient of each axis.
freq_offset_ppm (float) – The fat offset the pulse carries (ppm).
freq_offset_hz (float) – The offset at
system.B0(Hz); informational, the pulse carriesfreq_offset_ppm.
- Raises:
ValueError – If a bandwidth, time-bandwidth product or voxel size is not positive, or
spoiling_cyclesis not positive.
Examples
>>> import pypulseqpp.sequences as design >>> import pypulseqpp as pp >>> fatsat = design.FatSaturation(pp.Opts(B0=3.0)) >>> len(fatsat.blocks), round(fatsat.freq_offset_hz) (2, -441)
>>> [event.type for event in fatsat.blocks[0]] ['rf']
The pulse with its spoiler, and the longitudinal magnetisation left across the spectrum. The band sits at the fat resonance for the field the module was designed at, and water at zero offset is untouched:
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