Merge branch 'main' into feature/key-simplification

Author: 777arc

sigmf/__init__.py

@@ -5,7 +5,8 @@
 # SPDX-License-Identifier: LGPL-3.0-or-later
 
 # version of this python module
-__version__ = "1.11.0"
+__version__ = "1.12.0"
+
 # matching version of the SigMF specification
 __specification__ = "1.2.6"
 

sigmf/siggen.py

@@ -560,6 +560,9 @@ def create_full_signal_annotation(label: str) -> dict:
             phase_annotation = create_full_signal_annotation(f"phase offset {phase_deg:+.1f}°")
             annotations.append(phase_annotation)
 
+        # sort annotations by sample_start to satisfy sigmf ordering requirement
+        annotations.sort(key=lambda a: a[SigMFFile.START_INDEX_KEY])
+
         return annotations
 
     def _build_metadata(self, samples: np.ndarray) -> dict:

tests/test_siggen.py

@@ -319,7 +319,7 @@ def test_phase_offset(self):
         signal_0 = SigMFGenerator(seed=42).tone().generate()
         signal_1 = SigMFGenerator(seed=42).tone().phase_offset(phase_offset).generate()
 
-        # find where the actual signal starts by looking at annotations
+        # tone annotations are last after sorting (full-signal annotations start at 0)
         start_idx_0 = signal_0.get_annotations()[0][sigmf.SAMPLE_START_KEY]
         start_idx_1 = signal_1.get_annotations()[0][sigmf.SAMPLE_START_KEY]