Skip to main content

Module recording_file

Module recording_file 

Source
Expand description

Plain on-disk SigMF recordings: a .sigmf-meta file and its .sigmf-data dataset side by side in one directory.

A frame is one sample for each of the core:num_channels channels; samples are exchanged as flat lists of SampleValues in on-disk order (see utils::data).

§Sample indices

Sample indices are absolute, as in the SigMF specification: the first frame stored in the dataset has index core:offset (zero when omitted), reported by Recording::first_sample_index. core:sample_start values of captures and annotations use the same index space. Non-conforming dataset (NCD) capture header bytes (core:header_bytes) and core:trailing_bytes are skipped when reading.

Structs§

FrameBlocks
Iterator over blocks of frames, created by Recording::frame_blocks.
Recording
An open plain SigMF recording: parsed metadata plus a handle to its dataset file.
RecordingWriter
Writes a new plain recording (dataset and metadata) without replacing existing files.