Expand description
Plain on-disk SigMF recordings: a .sigmf-meta file and its .sigmf-data
dataset side by side in one directory.
Recordingopens an existing recording and reads sample frames by absolute SigMF sample index, either all at once withRecording::read_framesor in bounded blocks withRecording::frame_blocks(FrameBlocks).RecordingWriterstreams frames into a new recording and publishes the dataset and metadata, includingcore:sha512, without overwriting existing files.Recording::crop_tocombines both to extract a sample range into a new recording.
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§
- Frame
Blocks - 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.
- Recording
Writer - Writes a new plain recording (dataset and metadata) without replacing existing files.