The sigmf library makes it easy to interact with Signal Metadata Format
(SigMF) recordings. This library is compatible with Python 3.10-3.14 and is distributed
freely under the terms GNU Lesser GPL v3 License.
This module follows the SigMF specification html/pdf from the spec repository.
Install
pip install sigmf
# or
conda install sigmf
# or
mamba install sigmf
Read SigMF
import sigmf
# read SigMF recording
meta = sigmf.fromfile("recording.sigmf-meta")
samples = meta[0:1024] # get first 1024 samples
sample_rate = meta.sample_rate # get sample rate
# read compressed SigMF archives
meta = sigmf.fromfile("recording.sigmf.gz") # gzip-compressed
meta = sigmf.fromfile("recording.sigmf.xz") # xz-compressed
meta = sigmf.fromfile("recording.sigmf.zip") # zip archive
# read other formats containing RF time series as SigMF
meta = sigmf.fromfile("recording.wav") # WAV
meta = sigmf.fromfile("recording.cdif") # BLUE / Platinum
meta = sigmf.fromfile("recording.xml") # Signal Hound Spike
Write SigMF
import numpy as np
import sigmf
data = np.array([0.1 + 0.2j, 0.3 + 0.4j], dtype=np.complex64)
meta = sigmf.fromarray(data)
# optional additional metadata
meta.sample_rate = 8000
meta.description = "sample recording"
meta.add_capture(start_index=0, metadata={sigmf.FREQUENCY_KEY: 915e6})
# creates recording.sigmf-data and recording.sigmf-meta
meta.tofile("recording")
# or create compressed archive
meta.tofile("recording.sigmf.gz")
Docs
Please visit our documentation for full API reference and more info.
5 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sigmf-1.13.0.tar.gz.
File metadata
- Download URL: sigmf-1.13.0.tar.gz
- Upload date:
- Size: 92.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e59df0f9bc111c5bc0cbe655e62666de69cd5cdff5e7fa8cc4f539557466ab1b
|
|
| MD5 |
a1d63e04720d7cb14c661ce3564ccb2a
|
|
| BLAKE2b-256 |
670cd1cb848c8dccb986c9e0f916f984875b6b7e404d0c06bc4cdcc76d09a286
|
File details
Details for the file sigmf-1.13.0-py3-none-any.whl.
File metadata
- Download URL: sigmf-1.13.0-py3-none-any.whl
- Upload date:
- Size: 66.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
51b273f00562c92667e0e25b85450b7a8e488a303f3e6fd376c3b168e4343362
|
|
| MD5 |
2f075663a9083bfabe3da8c86dfc2d23
|
|
| BLAKE2b-256 |
3b08dea5f39c38eb619db9704ee6f7b2e1edb6a05f737680c34f142c2e7be088
|
