Initial commit of prototype converter for Rohde and Schwarz IQ.TAR by KelseyCreekSoftware · Pull Request #144 · sigmf/sigmf-python

KelseyCreekSoftware · 2026-04-04T19:02:10Z

See TODOs and project page for more detail.
https://github.com/KelseyCreekSoftware/KelseyCreekSoftware/blob/main/Rohde-Schwarz-Project-Notes.md

codacy-production · 2026-04-04T19:03:31Z

Not up to standards ⛔

🔴 Issues17 high

Alerts:
⚠ 17 issues (≤ 0 issues of at least minor severity)
Results:
17 new issues
Category Results
Security 17 high
View in Codacy

🟢 Metrics90 complexity · 5 duplication

Metric Results
Complexity 90
Duplication 5
View in Codacy

_{TIP This summary will be updated as you push new changes. Give us feedback}

Teque5 · 2026-04-08T18:41:36Z

Before we get going on this Rohde & Swarz support, is pr #136 ready to merge? If so let's do that and then you can rebase this branch.

KelseyCreekSoftware · 2026-04-08T19:22:46Z

Sure, that sounds like a good plan.
I think the Spike Signal Hound branch is ready to merge, but I'm just learning about the SigMF python library, so would defer to others.

Teque5 · 2026-04-14T14:34:08Z

I merged the Signal Hound branch so you should be able to rebase this branch to main now.

…les. See TODOs and project page for more detail.

…th optional search-anywhere behavior.

777arc · 2026-05-24T12:35:59Z

 from . import detect_converter
 from .blue import blue_to_sigmf
 from .signalhound import signalhound_to_sigmf
+from .signalhound import signalhound_to_sigmf


repeated line

Copilot

Pull request overview

Adds an initial Rohde & Schwarz IQ.TAR → SigMF conversion path to the sigmf.convert subsystem, wiring it into converter auto-detection and the sigmf_convert CLI, and introducing tests to validate key behaviors.

Changes:

Introduce sigmf/convert/rohdeschwarz.py implementing IQ.TAR extraction, XML parsing/validation, SigMF metadata construction, and dataset/archive/NCD writing.
Extend converter detection + CLI dispatch to recognize .tar IQ.TAR recordings and invoke the new converter.
Add unit tests covering XML-to-dict conversion, TAR extraction, validation failures, metadata building, IQ reading, and NCD creation.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 15 comments.

File	Description
`sigmf/convert/rohdeschwarz.py`	New Rohde & Schwarz IQ.TAR converter implementation (extraction, validation, metadata + data conversion, output writing).
`sigmf/convert/__init__.py`	Extend converter detection to recognize Rohde & Schwarz IQ.TAR and enhance magic-byte lookup.
`sigmf/convert/__main__.py`	Wire the new converter into the unified conversion CLI.
`tests/test_convert_rohdeschwarz.py`	New test suite for the Rohde & Schwarz converter.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

KelseyCreekSoftware · 2026-06-16T20:24:13Z

+ member_path = os.path.join(target_dir, member.name)
+ abs_target = os.path.abspath(target_dir)
+ abs_member = os.path.abspath(member_path)
+
+ return abs_member.startswith(abs_target)


+def safe_extract(tar, target_dir):
+ """
+ Extract only safe members from a tarfile.
+ """
+ for member in tar.getmembers():
+ if not is_safe_member(tar, member, target_dir):
+ raise Exception(f"Unsafe path detected in TAR: {member.name}")
+ tar.extract(member, target_dir)
+


KelseyCreekSoftware · 2026-06-16T01:37:41Z

+ # validate CenterFrequency
+ center_freq_raw = _text_of(root, "Clock")
+ try:
+ center_frequency = float(center_freq_raw)
+ except (TypeError, ValueError) as err:
+ raise SigMFConversionError(f"Invalid or missing CenterFrequency: {center_freq_raw}") from err
+
+ # validate SampleRate
+ num_samples_raw = _text_of(root, "Samples")
+ try:
+ sample_rate = float(num_samples_raw)
+ except (TypeError, ValueError) as err:
+ raise SigMFConversionError(f"Invalid or missing SampleRate: {num_samples_raw}") from err
+
+ if sample_rate <= 0:
+ raise SigMFConversionError(f"Invalid SampleRate: {sample_rate} (must be > 0)")
+


KelseyCreekSoftware · 2026-06-16T01:37:11Z

+ # add optional rohdeschwarz-specific fields to global metadata using rohdeschwarz: namespace
+ # only include fields that aren't already represented in standard SigMF metadata
+ if scaling_factor:
+ global_md["rohdeschwarz:scaling_factor"] = scaling_factor
+ if datafilename:
+ global_md["rohdeschwarz:iq_datafilename"] = datafilename # provenance
+ if userdata:
+ global_md["rohdeschwarz:userdata"] = userdata #open ended field for user defined data.
+ if preview_data:
+ global_md["rohdeschwarz:preview_trace"] = preview_data 


Updated to reflect when 0.0 would be appropriate based on current understanding of R&S data.

KelseyCreekSoftware · 2026-06-16T01:30:28Z

+ # Get unique IQ filename from global_info
+ iq_filename = global_info.get("rohdeschwarz:iq_datafilename")
+ print(f"iq_filename: {iq_filename}")


+ elif file_path.suffix in [".tar"]:
+ # iq.tar file extensions are used by Rohde & Schwarz for their IQ data, but the .tar extension is also used by other formats.
+ # So parse the tar file to determine if it is a Rohde & Schwarz file or not. 
+ rohde_schwarz_expanded_magic_bytes = get_magic_bytes(file_path, count=20, offset=0,magic_bytes=b"RS_IQ_TAR_FileFormat") # <RS_IQ_TAR_FileFormat>
+ if rohde_schwarz_expanded_magic_bytes == b"RS_IQ_TAR_FileFormat":
+ return "rohdeschwarz"
+ else:
+ raise SigMFConversionError(
+ f"Unsupported XML file format. Root element: {rohde_schwarz_expanded_magic_bytes}. "
+ f"Expected RS_IQ_TAR_FileFormat for IQ.TAR files."
+ )
+


KelseyCreekSoftware · 2026-06-15T23:37:08Z

+"""
+Create a minimal, valid Rohde & Schwarz IQ.TAR file for testing.
+"""


KelseyCreekSoftware · 2026-06-15T23:36:53Z

+ data_file_path = rohdeschwarz_path.parent / iq_filename
+ print(f"data_file_path: {data_file_path}")


KelseyCreekSoftware · 2026-06-15T23:36:34Z

+ output_dir = filenames["archive_fn"].parent
+ output_dir.mkdir(parents=True, exist_ok=True)
+ meta.tofile(filenames["archive_fn"], toarchive=True)
+ log.info("wrote SigMF archive to %s", filenames["archive_fn"])


KelseyCreekSoftware · 2026-06-15T23:35:54Z

+ # write metadata file
+ meta.tofile(filenames["meta_fn"], toarchive=False)
+ log.info("wrote SigMF metadata to %s", filenames["meta_fn"])


KelseyCreekSoftware · 2026-06-03T00:20:46Z

Need to update this PR to reflect all of the cool work going on in sigmf, including new use of Hypothesis.

…o look for and fix code errors.

KelseyCreekSoftware · 2026-07-20T00:00:01Z

I have updated the R&S tests to use hypothesis and have done additional testing to compare data rendered in one of the R&S IQ.tar file viewers. But still not sure when I compare the output, if the converter is handling the IQ data properly. There may be a fundamental error in my IQ conversion code that I cannot see. I do think that the XML looks OK, and the normal converter options seem to work as expected. So with those important disclaimers, I will remove the draft and request review.

KelseyCreekSoftware · 2026-07-20T00:01:57Z

(Note that the failing test is related to the long runtime in the new test_siggen.py related to an unbounded hypothesis range)

KelseyCreekSoftware mentioned this pull request Apr 5, 2026
Converter for Rohde & Schwarz Recordings #130
Open
5 tasks

KelseyCreekSoftware added 3 commits May 13, 2026 19:11

Initial commit of prototype converter for Rohde and Schwarz IQ.TAR fi…
cff5af6
…les. See TODOs and project page for more detail.

Working on Codacy security code issues.
3ad18dc

Adding mainly AI created pytest that seems to work.
09fd807

KelseyCreekSoftware force-pushed the feature/rohdeschwarz branch from c711b3b to 09fd807Compare May 14, 2026 02:13

KelseyCreekSoftware added 3 commits May 14, 2026 15:43

Updating byte offset for MagicBytes function.
84a6d18

Adding additional flexibility for R&S XML - extend get_magic_bytes wi…
d85c82e
…th optional search-anywhere behavior.

Adding support for Python 3.9 with use of Optional.
2300d7d

777arc reviewed May 24, 2026
View reviewed changes

777arc requested a review from Copilot May 24, 2026 12:36

Copilotstarted reviewing on behalf of 777arc May 24, 2026 12:36 View session

CopilotAI reviewed May 24, 2026
View reviewed changes

KelseyCreekSoftware marked this pull request as draft June 3, 2026 00:22

KelseyCreekSoftware added 11 commits June 2, 2026 20:43

Minor updates- need to merge in main to catch up on latest sigmf work
750c38e

Minor updates- need to merge in main to catch up on latest sigmf work
6d2977f

Merge branch 'main' into feature/rohdeschwarz
bd190c0

Working on R&S converter fixes and updates.
18c2209

Starting work on Co-Pilot code review. More to do here!
8bb2a50

Ignore .venv environment file
c52499c

Fixing meta.to file signature to add overwrite.
4557098

Additional work on Co-Pilot code review. One more fix to do.
8082165

Completed all Co-pilot review items, and then used Claude Haiku 4.5 t…
9e90017
…o look for and fix code errors.

Progress check-in for R&S converter and updates to associated test code.
6501d8c

Minor code updates.
6c369ed

KelseyCreekSoftware marked this pull request as ready for review July 20, 2026 00:02

		data_file_path = rohdeschwarz_path.parent / iq_filename
		print(f"data_file_path: {data_file_path}")

Uh oh!

Conversation

KelseyCreekSoftware commented Apr 4, 2026

Uh oh!

codacy-productionBot commented Apr 4, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Not up to standards ⛔

Uh oh!

Teque5 commented Apr 8, 2026

Uh oh!

KelseyCreekSoftware commented Apr 8, 2026

Uh oh!

Teque5 commented Apr 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KelseyCreekSoftware commented Jun 3, 2026

Uh oh!

KelseyCreekSoftware commented Jul 20, 2026

Uh oh!

KelseyCreekSoftware commented Jul 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codacy-productionBot commented Apr 4, 2026•
edited
Loading