[towards v1.5.x] Bump RF storage to v1.5.x

examples/scripts/write_2Dt1_mprage.py

@@ -39,10 +39,11 @@
     apodization=0.5,
     time_bw_product=4,
     return_gz=True,
+    use='excitation',
 )
 
 flip90 = 90 * pi / 180
-rf90 = pp.make_block_pulse(flip_angle=flip90, system=system, duration=500e-6, time_bw_product=4)
+rf90 = pp.make_block_pulse(flip_angle=flip90, system=system, duration=500e-6, time_bw_product=4, use='preparation')
 
 # =========
 # Readout

examples/scripts/write_3Dt1_mprage.py

@@ -28,10 +28,12 @@
 # RF preparatory, excitation
 # =========
 flip_exc = 12 * pi / 180
-rf = pp.make_block_pulse(flip_angle=flip_exc, system=system, duration=250e-6, time_bw_product=4)
+rf = pp.make_block_pulse(flip_angle=flip_exc, system=system, duration=250e-6, time_bw_product=4, use='excitation')
 
 flip_prep = 90 * pi / 180
-rf_prep = pp.make_block_pulse(flip_angle=flip_prep, system=system, duration=500e-6, time_bw_product=4)
+rf_prep = pp.make_block_pulse(
+    flip_angle=flip_prep, system=system, duration=500e-6, time_bw_product=4, use='preparation'
+)
 
 # =========
 # Readout

examples/scripts/write_epi.py

@@ -43,6 +43,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'epi_p
         time_bw_product=4,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
 
     # Define other gradients and ADC events

examples/scripts/write_epi_label.py

@@ -47,6 +47,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'epi_l
         time_bw_product=4,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
 
     # Define trigger

examples/scripts/write_epi_se.py

@@ -39,6 +39,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'epi_s
         time_bw_product=4,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
 
     # Define other gradients and ADC events

examples/scripts/write_epi_se_rs.py

@@ -57,6 +57,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'epi_s
         bandwidth=np.abs(sat_freq),
         freq_offset=sat_freq,
         delay=system.rf_dead_time,
+        use='saturation',
     )
     gz_fs = pp.make_trapezoid(channel='z', system=system, delay=pp.calc_duration(rf_fs), area=1 / 1e-4)
 
@@ -70,6 +71,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'epi_s
         time_bw_product=4,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
 
     # Create 90 degree slice refocusing pulse and gradients

examples/scripts/write_gre.py

@@ -44,6 +44,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'gre_p
         system=system,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
     # Define other gradients and ADC events
     delta_k = 1 / fov

examples/scripts/write_gre_label.py

@@ -47,6 +47,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'gre_l
         system=system,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
 
     # Define other gradients and ADC events

examples/scripts/write_haste.py

@@ -72,6 +72,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'haste
         phase_offset=rfex_phase,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
     GS_ex = make_trapezoid(
         channel='z',

examples/scripts/write_mprage.py

@@ -45,9 +45,16 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'mprag
     ax.n3 = xyz.index(ax.d3)
 
     # Create alpha-degree hard pulse and gradient
-    rf = pp.make_block_pulse(flip_angle=alpha * np.pi / 180, system=system, duration=rf_len, delay=system.rf_dead_time)
+    rf = pp.make_block_pulse(
+        flip_angle=alpha * np.pi / 180, system=system, duration=rf_len, delay=system.rf_dead_time, use='excitation'
+    )
     rf180 = pp.make_adiabatic_pulse(
-        pulse_type='hypsec', system=system, duration=10.24e-3, dwell=1e-5, delay=system.rf_dead_time
+        pulse_type='hypsec',
+        system=system,
+        duration=10.24e-3,
+        dwell=1e-5,
+        delay=system.rf_dead_time,
+        use='inversion',
     )
 
     # Define other gradients and ADC events

examples/scripts/write_radial_gre.py

@@ -45,6 +45,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'gre_r
         time_bw_product=4,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
 
     # Define other gradients and ADC events

examples/scripts/write_tse.py

@@ -63,6 +63,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'tse_p
         phase_offset=rf_ex_phase,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
     gs_ex = pp.make_trapezoid(
         channel='z',

examples/scripts/write_ute.py

@@ -54,6 +54,7 @@ def main(plot: bool = False, write_seq: bool = False, seq_filename: str = 'ute_p
         system=system,
         return_gz=True,
         delay=system.rf_dead_time,
+        use='excitation',
     )
 
     # Align RO asymmetry to ADC samples

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pypulseq"
-version = "1.4.2.post1"
+version = "1.5.0"
 authors = [{ name = "Keerthi Sravan Ravi", email = "ks3621@columbia.edu" }]
 maintainers = [
   { name = "Bilal Tasdelen" },

src/pypulseq/Sequence/block.py

@@ -187,6 +187,7 @@ def set_block(self, block_index: int, *args: SimpleNamespace) -> None:
         # Now we add the ID
         new_block[6] = extension_id
 
+    # TODO: replace with independent function (#PR 289)
     # =========
     # PERFORM GRADIENT CHECKS
     # =========
@@ -263,11 +264,15 @@ def set_block(self, block_index: int, *args: SimpleNamespace) -> None:
             and abs(grad_to_check.stop[0] - duration) > 1e-7
         ):
             raise RuntimeError("A gradient that doesn't end at zero needs to be aligned to the block boundary.")
+    # =========
+    # END GRADIENT CHECKS
+    # =========
 
     self.block_events[block_index] = new_block
     self.block_durations[block_index] = float(duration)
 
 
+# TODO: refactor to get_raw_block_content_id + get_block
 def get_block(self, block_index: int) -> SimpleNamespace:
     """
     Returns PyPulseq block at `block_index` position in `self.block_events`.
@@ -673,8 +678,19 @@ def register_rf_event(self, event: SimpleNamespace) -> Tuple[int, List[int]]:
             use = event.use[0]
         else:
             use = 'u'
+    else:
+        raise ValueError('Parameter "use" is not optional since v1.5.0')
 
-    data = (amplitude, *shape_IDs, event.delay, event.freq_offset, event.phase_offset)
+    data = (
+        amplitude,
+        *shape_IDs,
+        event.center,
+        event.delay,
+        event.freq_ppm,
+        event.phase_ppm,
+        event.freq_offset,
+        event.phase_offset,
+    )
 
     if may_exist:
         rf_id, found = self.rf_library.find_or_insert(new_data=data, data_type=use)
@@ -686,4 +702,7 @@ def register_rf_event(self, event: SimpleNamespace) -> Tuple[int, List[int]]:
     else:
         rf_id = self.rf_library.insert(key_id=0, new_data=data, data_type=use)
 
+    if hasattr(event, 'name'):
+        self.rf_id_to_name_map[rf_id] = event.name
+
     return rf_id, shape_IDs