Signal Hound Converter

[KelseyCreekSoftware]

This is preliminary work for a Spike Signal Hound converter.
I attempted to use the SigMF File API as much as possible and follow the general form of the blue and wav converters.
Very limited testing, but archive, NCD and XML conversion seems to work.
One thing that needs to be validated is the handling of the IQ file data itself.
The Spike XML files contain a small CSV sample of the larger IQ file. Not sure what the best way to handle this "preview" data.
There are other TODO items called out in the code.

[Teque5]

I'll assume this isn't quite ready yet, but I'm keeping an eye on it.

[Teque5]

This function should return SigMFFile object and not dict.

[Teque5]

A logger gets created by __main__.main() so I don't think we need this.

[Teque5]

you appear to define this again later, so I think you can delete these globals

[KelseyCreekSoftware]

@Teque5 - Slowly working to understand the https://sigmf.readthedocs.io/en/latest/_autosummary/sigmf.sigmffile.SigMFFile.html#
behaviors and convert my dictionary centric code to use the appropriate SigMFFile object. With the docs and the blue sample, not sure why this is taking me so long. :)

[KelseyCreekSoftware]

@Teque5 - I added my attempts at using the SigMF file object. It sort of works, but --ncd and --archive are badly broken. https://github.com/KelseyCreekSoftware/sigmf-python/blob/feature/signalhound/sigmf/convert/signalhound_fileobject_broken.py

This file at least generates valid meta data. https://github.com/KelseyCreekSoftware/sigmf-python/blob/feature/signalhound/sigmf/convert/signalhound.py

In both many TODOs, and overly verbose code.

[Teque5]

I am done refactoring.

• Add tests
• Documentation
• NCD support
• fromfile() support

I kinda wish we had more than one example file, but as far as I can tell this is ready to merge and tag as v1.8.0.

• This branch does need to be rebased to the latest sigmf:main

[KelseyCreekSoftware]

Good deal @Teque5!

Maybe @777arc can spin up two more samples. Perhaps a very small one and a medium to big one.

I did create an invalid.xml file to test the magic bytes. It should fail on xml that doesn't contain:

<?xml version="1.0" encoding="UTF-8"?>
<SignalHoundIQFileVersion="1.0">

So the InvalidXMLTestFile.xml contains:

<?xml version="1.0" encoding="UTF-8"?>
<BadDogVersion="2.0">
<BarkCount>100000</BarkCount>
</BadDog>

[777arc]

I upgraded to the latest Spike so now the zero-span mode saves directly as SigMF 😄

The converter is still valuable for the countless recordings people already have, but we probably don't have to go too crazy validating it under every corner case

[KelseyCreekSoftware]

@Teque5 and @777arc - I think this PR is ready to merge but would defer to others, as I'm new to the SigMF and production level python coding.

[777arc]

Yeah I agree it's a good point to merge it in, assuming last minute tests and functionality still seem good to go

[codacy-production]

Not up to standards ⛔

🔴 Issues1 critical · 1 medium

Alerts:
⚠ 2 issues (≤ 0 issues of at least minor severity)

Results:
2 new issues

Category	Results
Security	1 critical 1 medium

View in Codacy

🟢 Metrics78 complexity · 7 duplication

Metric	Results
Complexity	78
Duplication	7

View in Codacy

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