data_processing/README.md

# Ophthalmic Multimodal Data Processing & Curation Toolkit

<div align="center">

**Official Data Curation, De-identification, Quality Control & Taxonomy Standardization Pipeline for MM-OphBench**

[![Hugging Face Dataset](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Dataset-blue)](https://huggingface.co/datasets/Kaphathy/Dataset)
[![Toolkit Directory](https://img.shields.io/badge/Directory-data__processing-brightgreen)]()
[![Contributors](https://img.shields.io/badge/Contributors-Lisicheng%20|%20Zhanghuan%20|%20Huchengwei%20|%20Team-orange)]()

</div>

---

## 1. 概述 (Executive Summary)

本目录为 **MM-OphBench** 大规模多中心多模态眼科基准数据集（4,307,415 张图像、7 大临床影像模态）的**官方数据预处理、脱敏、质控与标准化代码库**。

为保证科研复现性与数据工程透明度，本目录将所有曾经用于清洗原始医院数据、公开集裁剪、伪影过滤、Excel 跨表校对、病灶匹配以及疾病分类学构建的生产级代码集中归档。**每一个脚本的文件头均附有详细的中英文注释，严格标明其原本用途、所适用的具体数据集、作者及输入输出规范。**

---

## 2. 目录架构 (Directory Structure)

```text
data_processing/
├── README.md                          # 本说明指南与全量速查矩阵表
├── 01_deidentification/               # 隐私脱敏、视网膜圆剪裁与黑框消除
│   ├── deidentify_batch.py            # [通用眼底大集] 批量多进程几何圆掩模与 OCR 正则脱敏 (李思成)
│   ├── audit_fundus_corner_pii.py     # [全库眼底图] OCR 与角部像素密度 PII 自动化复审 (李思成)
│   ├── crop_fundus_images.py          # [CSDI/公开眼底集] 自动轮廓提取与多余黑边裁剪 (张焕)
│   ├── deidentify_trial.py            # [眼底算法库] Otsu 圆掩模与局部遮盖核心算法 (李思成)
│   ├── fundus_pii_trial.py            # [眼底相片] 烧录文字交互式可视化核验工具 (李思成)
│   └── test_deidentify_trial.py       # [测试套件] 几何掩模提取单元回归测试 (李思成)
│
├── 02_quality_control/                # 图像质量评估、伪影检测与表格清洗
│   ├── asrm_preprocess.py             # [全库眼底图] 基于 ASRMNet 的清晰度与可诊断性质控 (张焕)
│   ├── clean_excel.py                 # [data0410/fundus_hcw] 原始诊断 Excel 表格清洗对齐 (胡成伟)
│   ├── build_hcw_semantic_patch.py    # [data0410/fundus_hcw] 隐私安全诊断侧卡 Parquet 生成 (李思成)
│   ├── scan_eyepacs_edge_artifact.py  # [EyePACS] 历史底片冷冻灰阶边缘伪影扫描 (李思成/团队)
│   ├── build_quality_risk_review.py   # [全库 7 模态] 破损文件头、极端长宽比与曝光异常排查 (李思成)
│   ├── filter_prompt_artifacts.py     # [多模态 Prompt] 提示词格式去噪与非法符号过滤 (李思成)
│   ├── prompt_qc.py                   # [多模态 Prompt] 临床提示词解剖层级语法校验 (李思成)
│   └── resize_mode_qc.py              # [多分辨率图] 下采样缩放失真监控与模式验证 (李思成)
│
├── 03_report_parsing/                 # 临床报告解析、跨模态检索与主清单物化
│   ├── materialize_newdata_prompts.py # [多中心新增集] 41 列标准模式多模态主清单生成 (李思成)
│   ├── attach_labels.py               # [同仁/浙二等] 自由文本临床病历报告与图像记录合并 (李思成)
│   ├── batch_retrieve_reports.py      # [OCT_LES_CW_V1] RoBERTa-SigLIP 零样本图文病灶匹配 (张焕)
│   └── cohorts.py                     # [全局字典] 多中心合作医院与模态配置主注册表 (李思成)
│
├── 04_modality_split/                 # 混杂模态自动化解耦拆分
│   └── split_octbuckets_octa_review.py# [data0410/octBuckets] 启发式多特征拆分 B-scan/OCTA/SLO (李思成)
│
└── 05_taxonomy_and_prompts/           # 疾病分类标准化与 Prompt 净化
    ├── build_mixed_v5_taxonomy.py     # [跨院病历] 临床诊断多表交叉映射字典 (Crosswalk) (李思成)
    ├── build_mixed_v6_taxonomy.py     # [全库 95 类] 对齐 ICD/SNOMED 的 95 种眼病分类构建器 (李思成)
    ├── test_build_mixed_v6_taxonomy.py# [测试套件] 95 类分类学完整性单元测试 (李思成)
    ├── test_taxonomy_sampling.py      # [测试套件] 类别平衡与分层抽样算法测试 (李思成)
    └── build_clean_captions.py        # [全库 1.2M 图文] 提示词数据集专有名词去偏工具 (李思成/团队)
```

---

## 3. 核心速查表：脚本与针对数据集映射矩阵 (Master Mapping Matrix)

| 脚本文件名 | 适用/针对的数据集 (Target Dataset) | 原本用来做什么 (Original Purpose & Function) | 编写/贡献者 |
| :--- | :--- | :--- | :--- |
| `crop_fundus_images.py` | `CSDI` / `zhanghuan_selected_public` (公开眼底集) | 基于图像边缘梯度与轮廓拟合，自动切除四周不对称大黑边 | 张焕 (Zhanghuan) |
| `clean_excel.py` | `archives/data0410/` (`fundus_hcw.zip` 诊断表) | 清洗多源混乱 Excel，核验图片 ID，消除合并单元格与非法字符 | 胡成伟 (Huchengwei) |
| `asrm_preprocess.py` | 全库彩色眼底相片 (CFP) | 基于 ASRMNet 深度网络评估图像清晰度与临床可诊断性 | 张焕 (Zhanghuan) |
| `batch_retrieve_reports.py` | `archives/OCT_LES_CW_V1` (OCT 病灶图文对) | 基于 RoBERTa-SigLIP 模型进行零样本跨模态图文对齐与检索 | 张焕 (Zhanghuan) |
| `scan_eyepacs_edge_artifact.py` | `archives/EyePACS` (糖尿病视网膜筛查集) | 扫描并过滤历史底片中的冷冻灰阶伪影与非纯黑边框 | 李思成 / 团队 |
| `split_octbuckets_octa_review.py` | `archives/data0410/octBuckets.zip` (混合 OCT) | 提取纵横比、边缘密度、层状评分，拆分 B-scan / OCTA / SLO | 李思成 (Lisicheng) |
| `build_hcw_semantic_patch.py` | `archives/data0410/fundus_hcw` (眼底大集) | 剥离患者隐私列，生成纯净标准化诊断 Parquet 侧卡 | 李思成 (Lisicheng) |
| `deidentify_batch.py` | 多中心大规模原始眼底相片（同仁、浙二等数百万张） | 批量多进程圆形视网膜视野掩模覆盖与 OCR 正则敏感字符抹黑 | 李思成 (Lisicheng) |
| `audit_fundus_corner_pii.py` | 脱敏后的各中心眼底图库 (CFP / UWF) | 自动化扫描图像四角文字残留，进行合规性审计 | 李思成 (Lisicheng) |
| `deidentify_trial.py` | 通用眼底脱敏算法试算与调试 | Otsu 阈值视网膜轮廓提取与局部高斯/黑框脱敏核心算法库 | 李思成 (Lisicheng) |
| `build_clean_captions.py` | 全库 1.2M 跨模态预训练图文对 | 正则剔除提示词中 51.9% 泄露的数据集名，保留设备与病征 | 李思成 / 团队 |
| `build_mixed_v6_taxonomy.py` | 全库 95 类眼科疾病标注体系 | 对齐 ICD-10 与 SNOMED，生成 `tongren95_taxonomy.csv` 标准词典 | 李思成 (Lisicheng) |
| `materialize_newdata_prompts.py` | 多中心多模态新增图像与报告 | 将分散元数据聚合成 41 列标准模式的主清单 (Manifest) | 李思成 (Lisicheng) |
| `attach_labels.py` | 北京同仁、浙二等带临床报告队列 | 将非结构化自由病历文本与图像索引进行准确关联 | 李思成 (Lisicheng) |
| `build_quality_risk_review.py` | 全库 430 万+ 图文资产 (7 大模态) | 扫描图像文件头损坏、极端纵横比与曝光异常样本 | 李思成 (Lisicheng) |
| `filter_prompt_artifacts.py` | 多模态微调与生成提示词 Prompts | 清除自由文本病历转 Prompts 中的格式噪点与重复标签 | 李思成 (Lisicheng) |
| `prompt_qc.py` | 全库多模态提示词体系 | 校验提示词“检查类型-解剖部位-眼别-病征”层级语法 | 李思成 (Lisicheng) |
| `resize_mode_qc.py` | 全库跨硬件厂商的多分辨率图像 | 监控不同设备图像在下采样时的失真情况并建议缩放模式 | 李思成 (Lisicheng) |
| `cohorts.py` | 全库各中心数据集统一元数据字典 | 集中定义合作医院代码、模态类型与路径分发规则 | 李思成 (Lisicheng) |
| `build_mixed_v5_taxonomy.py` | 同仁、浙二、邯郸等原始病历诊断 | 多中心病历诊断词条多表交叉映射字典 (Crosswalk) | 李思成 (Lisicheng) |
| `fundus_pii_trial.py` | 带有设备硬烧录文字的水印眼底图 | 交互式与样本可视化抽检工具，叠加脱敏框与 OCR 框 | 李思成 (Lisicheng) |
| `test_deidentify_trial.py` | 几何掩模单元回归测试 | 保证复杂长宽比、偏心眼底图在脱敏时不误切视网膜 | 李思成 (Lisicheng) |
| `test_build_mixed_v6_taxonomy.py` | `tongren95_taxonomy.csv` 标准词典 | 验证 95 种眼病分类层级完整性与 ICD 映射无死角 | 李思成 (Lisicheng) |
| `test_taxonomy_sampling.py` | 全库长尾分布的多病种诊断数据集 | 验证针对罕见病与常见病的类别平衡抽样算法 | 李思成 (Lisicheng) |

---

## 4. 快速运行与依赖说明 (Quick Start)

所有脚本均在 Python 3.10–3.12 环境下通过验证。推荐安装如下核心科学计算与医学图像依赖：

```bash
pip install numpy pillow opencv-python pandas pyarrow openpyxl torch torchvision transformers easyocr tqdm
```

### 示例 1：对公共眼底集执行多余黑边自动裁切 (张焕)
```bash
python data_processing/01_deidentification/crop_fundus_images.py \
    --input_dir /path/to/raw_csdi_images \
    --output_dir /path/to/cropped_clean_images
```

### 示例 2：清洗多中心诊断 Excel 表格 (胡成伟)
```bash
python data_processing/02_quality_control/clean_excel.py \
    --excel_path /path/to/raw_diagnosis.xlsx \
    --output_csv /path/to/clean_diagnosis.csv
```

### 示例 3：拆分混杂模态 OCT 数据集 (李思成)
```bash
python data_processing/04_modality_split/split_octbuckets_octa_review.py \
    --manifest /path/to/adapter_manifest.parquet \
    --out_dir /path/to/octbuckets_split_output
```