compact_uint16/USAGE.md

# RFWM 完整训练数据使用说明

本仓库 `compact_uint16/` 提供完整 uint16 NumPy 训练包。每条 `.tar.gz` 包含 RSS、同步三路视觉、状态、动作、材料和配置；不需要从另一个仓库补齐内容。

## 下载与解压

安装客户端：`pip install huggingface_hub numpy`。下载发布清单，再按清单路径下载需要的样本：

```python
import hashlib
import json
from pathlib import Path
from huggingface_hub import HfApi, hf_hub_download

repo = "DaftJun/RFWM"
revision = HfApi().repo_info(repo, repo_type="dataset").sha
manifest = hf_hub_download(repo, "compact_uint16/manifests/train.jsonl",
                           repo_type="dataset", revision=revision)
rows = [json.loads(line) for line in Path(manifest).read_text().splitlines() if line]
row = rows[0]  # 发布过程中清单会增长；可循环下载所有行。
archive = hf_hub_download(repo, row["path"], repo_type="dataset", revision=revision)
assert Path(archive).stat().st_size == row["bytes"]
digest = hashlib.sha256()
with open(archive, "rb") as stream:
    for block in iter(lambda: stream.read(8 * 1024 * 1024), b""):
        digest.update(block)
assert digest.hexdigest() == row["sha256"]
print(archive)
```

将打印出的归档解压到独立目录，例如 `tar -xzf sample.tar.gz -C extracted_sample`。不要把不同样本解压到同一个目录。每个包内都有 `read_sample.py`，可从样本目录导入，也可下载仓库中的 `compact_uint16/read_sample.py`。

## RSS 编码与读取

`rss_dbm_uint16.npy` 的逻辑轴为 `[time,height,y,x]`，通常是 `[30,24,512,512]`。Fortran 是磁盘存储顺序，不改变逻辑轴。高度逐样本变化，读取 `heights_m.npy`。时间读取 `timestamps_s.npy`，通常为 0–29 秒、间隔 1 秒。

```python
from read_sample import load_rss
rss_dbm = load_rss("extracted_sample", frames=slice(0, 5))
# 返回 C 连续 float32，单位 dBm，无效位置 NaN。
```

`quantization.json` 明确规定：步长 0.01 dB，整数偏移 32768，无效码 0。解码必须先转为有符号整数：

```python
import numpy as np
q = np.load("extracted_sample/rss_dbm_uint16.npy", mmap_mode="r", allow_pickle=False)
rss_dbm = (q.astype(np.int32) - 32768).astype(np.float32) * np.float32(0.01)
rss_dbm[q == 0] = np.nan
```

这一编码可精确恢复现有 centi-dBm 训练数组，无额外量化损失，不截断有效值；并不声称恢复 RT 输出量化之前的连续值。完整解码约需 720 MiB，训练时建议按帧或片段加载。无效位置不代表真实接收功率为零，损失函数应使用有效掩码排除 NaN。

## 视觉、状态和动作

- `visual/bs/`：基站位置广角第一视角，不是无人机机载视角。
- `visual/topdown/`：俯视图。
- `visual/elevated/`：高位侧向斜视图。
- 每路 30 张 PNG，共 90 张；`visual/synchronization.json` 保留帧时间、相机参数、UAV 标注与视觉质量诊断。可能被遮挡的视角按原样保留并标注。
- `states.npz` 用 NumPy 读取，键名保持原 HDF5 路径。`array_schema.json` 保留字段映射、属性与类型说明。
- `metadata.json` 保留来源版本、城市、`physical_episode_group`、控制协议、QA 协议和训练用途。
- `config.json`、`state_schema.json` 以及源样本提供的 `actions.json`、`scene_metadata.json` 同包保存。

```python
import numpy as np
with np.load("extracted_sample/states.npz", allow_pickle=False) as state:
    print(state.files)
    uav_position_m = state["state/uav_position_m"]
```

区域约为 1 km × 1 km，水平网格 512 × 512；具体坐标与范围以样本元数据为准。控制方式可能随历史版本变化，读取 `control_schedule`，不要假设所有样本都只在固定帧切换动作。

## 训练分组与数据范围

`manifests/dynamic_rf_train.jsonl` 是含动态 UAV RF 实体的主训练清单，`legacy_aux_train.jsonl` 是历史辅助清单。后者新增的光学 UAV 不意味着原 RF 已包含机体遮挡或反射。所有发布记录按用户要求归入训练集；不提供独立测试集。后续评估应按 `physical_episode_group` 分组，避免共享场景泄漏。

地图主要为真实建筑轮廓挤出几何，部分建筑高度为估计。视觉是合成渲染，材料参数含合成分组与动态变化，不是逐栋实测材料。固定预算单次 RT 样本不做统计置信度检查；保留每条样本真实的 `qa_protocol` 与 `confidence_evaluated`。

源仓库为 [PATIENTHZ/low-altitude-rf-worldmodel](https://huggingface.co/datasets/PATIENTHZ/low-altitude-rf-worldmodel)。两个仓库相同 record_id 的完整归档应有相同 SHA256，不要合并重复计数。新包会持续发布，清单只统计已提交的完整包；看到 README 不代表全量上传已完成。本仓库不上传原始重型 RF 归档、地图网格或旧版 float32 存储副本。