From e57c2afe4bda2f0e85887a8faf5385cd2a6a962b Mon Sep 17 00:00:00 2001 From: Luciano Righetti Date: Thu, 3 Aug 2023 11:58:09 +0200 Subject: [PATCH] add: sigmf module doc --- documentation/website/expansion/sigmf-expand.json | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 documentation/website/expansion/sigmf-expand.json diff --git a/documentation/website/expansion/sigmf-expand.json b/documentation/website/expansion/sigmf-expand.json new file mode 100644 index 0000000..2a0fe02 --- /dev/null +++ b/documentation/website/expansion/sigmf-expand.json @@ -0,0 +1,14 @@ +{ + "description": "Enrichs a SigMF Recording or extracts a SigMF Archive into a SigMF Recording.", + "requirements": [ + "matplotlib: For plotting the waterfall plot of the recording.", + "numpy: For the waterfall plot of the recording.", + "sigmf: For validating SigMF files." + ], + "input": "Object of sigmf-archive or sigmf-recording template.", + "output": "Object of sigmf-expanded-recording or sigmf-recording template.", + "references": [ + "https://github.com/sigmf/SigMF" + ], + "features": "This module can be used to expand a SigMF Recording object into a SigMF Expanded Recording object with a waterfall plot or to extract a SigMF Archive object into a SigMF Recording objet." +} \ No newline at end of file