Expand description
SigMF recording metadata: the contents of a .sigmf-meta file.
A SigMF metadata document is a JSON object with three required top-level keys, each modeled by its own type:
globalโ recording-wide properties such ascore:datatype,core:sample_rate, andcore:version(crate::global::Global);capturesโ segments of the dataset keyed bycore:sample_start(crate::capture::Capture);annotationsโ labeled sample and frequency ranges (crate::annotation::Annotation).
Metadata ties these together, parses and serializes the document
(preserving unknown extension keys), offers range queries over captures
and annotations, and writes validated metadata to disk. MetadataEdit
provides transactional, validate-then-commit editing, and
MetadataChange describes differences reported by Metadata::diff.
Structsยง
- Metadata
- A complete SigMF metadata document (
.sigmf-meta). - Metadata
Change - A single leaf-level difference reported by
Metadata::diff. - Metadata
Edit - A transactional edit of a
Metadatadocument, created byMetadata::edit.