Skip to main content

Module annotation

Module annotation 

Source
Expand description

SigMF annotation segments.

A SigMF metadata file has an annotations array whose entries describe features of interest in the recording, such as a detected burst, a labeled emitter, or a free-form comment. Each entry covers a range of samples starting at core:sample_start and may optionally be bounded in frequency. This module models a single entry as Annotation and provides AnnotationBuilder for constructing one with validated frequency bounds.

Keys in the core namespace map to typed fields on Annotation; any other keys (for example, extension fields) are preserved verbatim and exposed through Annotation::extra_fields.

Structsยง

Annotation
A single entry of the SigMF annotations array.
AnnotationBuilder
Builder for Annotation that validates frequency bounds on build.