diff --git a/README.md b/README.md index 528e020..6e99292 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,8 @@ The Library is a cross-repository browser for all RF and ML assets on the platfo 1. Push this repository (or clone it into your RIA Hub instance). The SigMF file pairs in `Recordings/` are tracked via Git LFS and will be indexed automatically on push. 2. Navigate to **Library** in the top navigation bar. 3. Select the **Recordings** tab. Each `.sigmf-data`/`.sigmf-meta` pair appears as a row with metadata and a spectrogram thumbnail. -4. Click any row to open the recording inspector — view the spectrogram, constellation, PSD, and time series tabs. +4. Click any row to open the **Quick View** panel — view the spectrogram, constellation, PSD, and time series tabs to assess signal quality. +5. To mark and export specific time segments, go to **Dataset Manager → Recording Inspector**, select a repository and recording, then drag keep/discard regions on the spectrogram. **Supported asset types in the Library:** @@ -78,6 +79,27 @@ The Library is a cross-repository browser for all RF and ML assets on the platfo --- +### Recording Inspector + +The Recording Inspector lets you visually select time segments from a recording, preview the export, and write the resulting SigMF file pairs to a repository branch. + +**Example files:** `Recordings/bpsk_915MHz/`, `Recordings/qpsk_915MHz/`, `Recordings/qam16_2400MHz/` + +**Steps:** +1. Go to **Dataset Manager → Recording Inspector**. +2. In **Repository**, type or select the repository containing the example recordings (e.g. `qoherent/RIA_Example`). +3. In **Recording**, select a `.sigmf-data` file. The spectrogram generates automatically (5–30 seconds). +4. Switch to **Keep** mode and drag on the spectrogram to mark the region you want to export. + - Use **Discard** mode to cut out interference or noise within a keep region. + - Use **Pan** mode to scroll and zoom to a different part of the recording. +5. Check the **Export Preview** panel — it shows the derived segments, total duration, and any warnings about short segments. +6. Set an **Export destination**: repository, branch, and folder. +7. Click **Export**. The segments are written as SigMF file pairs to the destination branch. + +The exported segments appear in the Library once the job completes and can be fed directly into the Curator. + +--- + ### Dataset Manager — Curator The Curator takes raw IQ recordings and produces a labelled, ready-to-train HDF5 dataset. It applies a configurable DSP pipeline: slicing, quality filtering, and optional augmentation.