SeismicX-Cont / README.zh.md
cangyeone's picture
Refine catalogue-conditioned output reporting
477d764 verified
|
Raw
History Blame
50.2 kB

SeismicX logo

SeismicX-Cont — HDF5 连续波形数据产品

面向部署级地震监测的结构化连续波形数据库

1. 概述

SeismicX-Cont 是一个经过处理和结构化组织的 HDF5 连续波形数据产品, 用于支持部署级地震监测研究。

该发布包在统一文件结构中保留连续波形、台站-时间覆盖、标注来源、仪器响应元数据 和验证流程。它是可复用的监测数据产品,不是相对模型评估资源,也不替代权威的 SCEDC、NCEDC 或 CEED 源数据档案。

仓库同时提供 SeismicX DataLoader、SQLite 覆盖查询工具、验证脚本和 quick-start notebook,便于对发布文件进行可复现访问。


1.1 项目目录结构

远程仓库目录组织如下:

data/
  hdf5/                 # 14 个 daily HDF5 波形文件
  index/                # SQLite 波形索引
  label/                # annotation、reference 表、可选 consensus 与多输出候选目录
  response/             # 仪器响应 JSON,用于 dataloader 去响应/仿真
  validation/           # 机器可读审计与可选多输出震相匹配诊断
notebooks/              # 交互式 quickstart notebook
pickers/                # 示例 TorchScript/ONNX picker 模型
scripts/                # 转换、索引、picker、关联和上传脚本
essd_scripts/           # ESSD 统计、诊断和绘图脚本
utils/                  # 可复用 HDF5 dataloader 和 waveform-index API

数据准备和 picker 相关命令主要放在 scripts/ 中;ESSD 论文中的关键数字、统计、 诊断和绘图命令放在 essd_scripts/ 中。 可用 essd_scripts/audit_manuscript_numbers.py 独立重新生成论文里的核心 inventory 和精确 NSLC coverage 数值,并用 essd_scripts/audit_waveform_quality.py 检查全量 索引完整性和分层抽样波形质量。稳定的机器可读摘要位于 data/validation/manuscript_number_audit.jsondata/validation/waveform_quality_audit.json;一键复现脚本会从发布文件刷新它们。 essd_scripts/build_reference_arrivals.py 会按确定性规则生成 data/label/reference_arrivals.sqlite:分量不会跨 location 或 channel family 组合,响应有效期按左闭右开处理;要求响应时,C3 的每个选定分量必须恰好匹配 一个响应历元。可选目录 data/validation/multimodel_phase_matching/ 保存多个现有 自动拾取输出的一对一匹配记录和摘要,可用 ./essd_scripts/regenerate_multimodel_phase_matching.sh 重新生成。它用于自动一致性 与文件互操作检查,不是模型比较,也不构成 ground truth。该脚本复用 reference_arrivals.sqlite 中已经由精确 NSLC 区间和有限 HDF5 样点生成的版本化 C0 标志,避免对每个输出重复扫描完整波形归档。 data/label/ 下的可选多输出候选目录保留九个非标准化示例运行的全部源拾取, 并在同一台站、同一 canonical 震相且严格小于 1.5 秒的时间跨度内聚合。 发布格式包括压缩 JSONL 和规范化 SQLite,便于查询输出一致性; output_eligibility.sqlite 记录各输出实际处理的台站-时间区间, output_registry.tsv 记录九组源输出的组成和处理范围。发布的分层验证表同时给出 候选侧目录匹配比例和人工参考恢复比例,并提供按 eligible 输出数归一化后的结果; 这些都是目录条件化诊断,不是传统 precision。多输出支持不等同于 ground truth, 也不能用于相对模型评估。字段和查询示例见 data/label/README_all_model_phase_picks.mdnotebooks/seismicx_cont_quickstart.ipynb 提供文件检查、SQLite 查询、HDF5 波形绘图、annotation 检查和评估命令模板。

当前 scripts/ 内容:

路径 用途
scripts/README_download_data.md 完整数据和 mini 数据的下载、重建说明。
scripts/README_event_comparison.md 事件对比流程说明和指标定义。
scripts/README_real_association.md REAL 关联的配置、输入输出和参数说明。
scripts/build_consensus_picks_json.py 从多个模型拾取结果构建 consensus pick annotation。
scripts/build_all_model_phase_catalog.py 构建紧凑的多输出候选 JSONL 和 SQLite 数据产品。
scripts/build_output_eligibility.py 构建输出处理区间 eligibility 数据库和 output registry。
scripts/build_waveform_index.sh 从 HDF5 文件构建完整发布的 SQLite 波形索引。
scripts/compare_associated_events.py 将关联事件与目录/参考事件进行对比。
scripts/download_instrument_responses.py 下载台站仪器响应元数据。
scripts/evaluate_picks.py 根据参考 pick 评估 picker JSONL 输出。
scripts/example_dataloader.py 最小 PyTorch HDF5WaveformDataset 使用示例。
scripts/example_query_waveform.py 通过 SQLite 查询波形片段,并可选进行响应处理。
scripts/getwaveform_cha_names.py 查看 HDF5 波形文件中的 channel-family 名称。
scripts/makeh5.py 将 MiniSEED 波形转换为原始 HDF5 结构。
scripts/makeh5_flex_seg.py 将波形转换为 flexible-segment HDF5 文件。
scripts/plot_dataset_overview.py 生成数据集 overview 图。
scripts/plot_essd_qc_figures.py 生成 ESSD 质量控制图。
scripts/readh5.py 查看任意 HDF5 的层级、dataset、link 和 attribute。
scripts/run_consensus_picks.sh 运行完整发布 consensus-pick 流程。
scripts/run_all_model_phase_catalog.sh 运行可恢复的九输出候选目录构建流程。
scripts/run_picker_to_jsonl.py 对 HDF5 样本运行一个 TorchScript picker,并写出 JSONL pick。
scripts/run_pickers.sh 批量运行完整发布 picker 模型。
scripts/run_real_association.py 将 picker JSONL 转为 REAL 输入并执行事件关联。
scripts/upload_files_to_hf.py 上传指定完整发布数据文件到 Hugging Face。
scripts/upload_files_to_ms.py 上传指定完整发布数据文件到 ModelScope。
scripts/upload_restfiles_hf.py 上传非大体量发布文件到 Hugging Face。
scripts/upload_restfiles_ms.py 上传 scripts/utils/ 更新到 ModelScope。
scripts/upload_all_model_phase_catalog.py 上传压缩的多输出候选目录及其说明。
scripts/validate_multi_output_candidates.py 复现按支持层级划分的 C0 人工参考一致性统计。
scripts/verify_full_dataset.py 检查完整发布的必需文件和基本结构。
scripts/write_manifest.sh 重新生成发布 checksum 和 file-size manifest。

发布元数据和完整性校验文件:

推荐 quickstart 和复现脚本顺序:

  1. 先运行 notebooks/seismicx_cont_quickstart.ipynb,检查仓库结构、文件校验、SQLite 查询和 HDF5 波形读取。
  2. python scripts/verify_full_dataset.py 检查完整发布结构。
  3. 从 HDF5 文件重建索引时,运行 ./scripts/build_waveform_index.sh
  4. ./scripts/write_manifest.sh 重新生成 checksum 和 file-size manifest。
  5. ./essd_scripts/reproduce_manuscript_outputs.sh 一键复现 ESSD 论文表格和图。
  6. 如已下载可选的 picker JSONL 源文件,用 ./essd_scripts/regenerate_multimodel_phase_matching.sh 重建多输出匹配诊断层。
  7. 解压 data/label/all_model_phase_picks.sqlite.zst 后查询可选多输出候选目录; 字段和示例见 data/label/README_all_model_phase_picks.md
  8. 使用 data/label/output_eligibility.sqlite 查询各输出的实际处理域,并用 data/validation/multi_output_manual_reference_match.tsvdata/validation/multi_output_eligibility_normalized_match.tsv 检查发布的支持分层结果。

2. 数据集说明

2.1 数据来源

本数据集包含来自三个区域地震网络的连续波形记录:

  • CI — 南加州地震网络
  • NC — 北加州地震网络
  • BK — 伯克利数字地震网络

这些网络提供了多样的观测条件,包括仪器响应差异、通道配置差异、噪声特征差异和台站密度差异。


2.2 时间窗口

提供两个代表性的 7 天连续时间窗口:

TIME_WINDOWS = [
    {
        "id": "day_20190701",
        "starttime": "2019-07-01T00:00:00",
        "endtime": "2019-07-08T00:00:00",
    },
    {
        "id": "day_20211108",
        "starttime": "2021-11-08T00:00:00",
        "endtime": "2021-11-15T00:00:00",
    },
]

每个时间窗口覆盖 7 个日历日;遥测缺口、部分通道缺测和浮点数组中的 非有限样点均保留并通过覆盖索引与 validity mask 显式表示。


2.3 数据内容

数据集包含 HDF5 格式的异构连续波形数据、台站元数据(经纬度、高程、有效期)、 保留缺口的分段波形记录,以及来源于 CEED 数据集 的事件标注。通道族和分量数 并不统一;垂直分量不会在默认访问接口中复制为伪三分量。


3. 监测时段设计

SeismicX-Cont 将两个一周长的监测时段放在同一套 HDF5、annotation、 response 和 coverage-index 结构中,便于在不同监测条件下复用连续数据流。

3.1 高活动窗口(2019 年 7 月)

该时段地震活动密集,事件频繁且可能重叠。复用时通常关注 coverage-qualified recall、震相残差、台站覆盖,以及密集地震序列中的工作流行为。

3.2 低活动窗口(2021 年 11 月)

该时段相对于 Ridgecrest 周为低活动背景。复用时通常关注 catalog-unmatched automatic-pick burden、噪声条件、台站可用性和长连续时段内的报告稳定性。 未匹配参考目录的自动拾取不应自动解释为确认的错误检测。


4. 数据结构

数据集采用层次化 HDF5 布局存储:

/year
  /day
    /stations
      /network.station.location
        /waveform
          /channel
            /segment

示例:

/2019-01-01T00:00:00.000000Z
  /2019-07-01T00:00:00.000000Z
    /stations
      /BK.BDM.00
        /waveform
          /BHE/0
          /BHN/0
          /BHZ/0

每个通道可能包含多个波形片段,加载时自动合并为连续数据。


5. SeismicX DataLoader

文件: utils/hdf5_waveform_dataset.py

基于 PyTorch Dataset 封装 HDF5 文件,输出带有完整台站元数据的波形张量。针对大型多文件数据集的单次推理场景进行了内存占用优化。


5.1 主要特性

多文件输入 — 支持单个文件、目录、通配符模式(data/hdf5/*.h5)或文件路径列表。

通道族分组 — 按通道代码的前两个字符(通道族)将波形分组,例如 BHE/BHN/BHZ 作为一个样本而非三个独立通道。

通道 通道族
BHE, BHN, BHZ BH
HHE, HHN, HHZ HH
HNE, HNN, HNZ / HN1, HN2, HN3 HN
EHE, EHN, EHZ EH

自动三分量构建 — E/1 → 位置 0,N/2 → 位置 1,Z/3 → 位置 2。仅有 Z 分量的台站可复制为 [Z, Z, Z]

多段合并 — HDF5 中连续的分段自动合并为一条连续迹线,间隙以 fill_value 填充。

可选重采样 — 使用线性插值重采样到目标采样率(不依赖 scipy)。

可选仪器响应处理 — dataloader 可基于 data/response/instrument_responses.json 去除原始仪器响应,并可进一步仿真到用户指定的目标响应。

内存安全的文件句柄缓存 — 同一时刻只保留当前 HDF5 文件的句柄;切换到新文件时立即关闭旧句柄(及其 chunk cache),内存占用维持 O(1),与文件数量无关。


5.2 构造参数

HDF5WaveformDataset(
    h5_file,
    mode="three",
    fill_value=0.0,
    dtype=np.float32,
    default_location="--",
    allowed_families=("HH", "BH", "EH", "HN"),
    allowed_z_only_channels=("EHZ",),
    allow_z_only=True,
    replicate_z_only=False,
    target_sampling_rate=None,
    skip_sample_keys=None,
    skip_jsonl=None,
    skip_record_type="phase_pick",
    keep_h5_open=True,
    include_segments_metadata=True,
    use_overlap_mask=True,
    h5_rdcc_nbytes=8 * 1024 * 1024,
    max_duration_sec=90000.0,
    instrument_response_json=None,
    remove_instrument_response=False,
    response_output="VEL",
    response_pre_filt=None,
    response_water_level=60,
    response_error_behavior="raise",
    simulate_instrument_response=False,
    simulation_response_json=None,
    simulation_response_id=None,
    simulation_response_selector=None,
    simulation_paz=None,
    simulation_output=None,
)
参数 类型 默认值 说明
h5_file str / Path / list 必填 单个文件、目录、通配符(data/hdf5/*.h5)或路径列表
mode str "three" 输出模式:"single""three""multi"
allowed_families tuple[str] ("HH","BH","EH","HN") 参与建索引的通道族
allowed_z_only_channels tuple[str] ("EHZ",) 允许作为仅 Z 通道的完整通道代码
allow_z_only bool True 是否收录仅含 Z 分量的台站
replicate_z_only bool False 是否显式启用 Z-only 到 [Z,Z,Z] 的合成复制
target_sampling_rate float 或 None None 目标采样率(Hz);None 保持原始采样率
fill_value float 0.0 多段合并间隙的填充值
dtype np.dtype np.float32 波形数组的 NumPy 数据类型
keep_h5_open bool True 缓存当前文件句柄;切换文件时关闭旧句柄
include_segments_metadata bool True 在输出 dict 中包含原始分段元数据(设为 False 可节省内存)
use_overlap_mask bool True 防止重叠分段互相覆盖
h5_rdcc_nbytes int 8 MB 每个文件句柄的 HDF5 chunk 缓存大小
max_duration_sec float 90000.0 单通道合并后迹线长度的安全上限
instrument_response_json str 或 None None 仪器响应 JSON 路径,通常为 data/response/instrument_responses.json
remove_instrument_response bool False 使用 ObsPy 去除原始仪器响应,返回物理量
response_output str "VEL" 去响应后的物理量,常用 "DISP""VEL""ACC"
response_pre_filt tuple 或 None None 传给 ObsPy remove_response 的四角频率预滤波
response_water_level float 或 None 60 ObsPy water level;若用 response_pre_filt 控制稳定性,可设为 None
response_error_behavior str "raise" 响应处理失败时的行为:"raise""warn""skip"
simulate_instrument_response bool False 在可选去响应之后仿真目标仪器响应
simulation_response_json str 或 None None 包含目标响应的 JSON;默认复用 instrument_response_json
simulation_response_id str 或 None None 需要仿真的精确 response_id
simulation_response_selector dict 或 None None networkstationlocationchannel 和可选 time 选择目标响应
simulation_paz dict 或 None None 另一种简单仿真方式:ObsPy 风格 PAZ 字典
simulation_output str 或 None None 计算目标响应时使用的物理量;默认等于 response_output
skip_sample_keys set 或 None None 预构建的排除集合(样本 key 集合)
skip_jsonl str 或 None None 已有输出 JSONL 的路径;启动时扫描并从索引中移除已完成的样本
skip_record_type str "phase_pick" 扫描 JSONL 时匹配的 record_type 字段值

5.3 输出模式

mode="single"

每个通道一个样本,输出 waveform 形状:[T]

mode="three"(推荐)

每个通道族一个样本,观测分量顺序为 E/N/Z(1/2/3 映射到相同位置)。默认情况下,Z-only 记录输出 [T, 1];只有显式设置 replicate_z_only=True 才构造 [Z,Z,Z]

mode="multi"

同一通道族中所有可用通道叠放,输出 waveform 形状:[T, C]

所有模式都返回 validity_mask(gap 填充值对应 False)和 component_mask(标记实际输出分量)。three 模式还返回 observed_component_mask;即使显式复制 Z,合成的水平分量也不会被标记为真实观测。 安装 SciPy 时,重采样使用带抗混叠的 polyphase 方法,mask 采用保守规则同步重采样。


5.4 使用示例

单文件:

from utils.hdf5_waveform_dataset import HDF5WaveformDataset, waveform_collate_fn

dataset = HDF5WaveformDataset(
    h5_file="data/hdf5/continuous_waveform_usa_20190701.h5",
    mode="three",
    target_sampling_rate=100.0,
)

通配符(多文件):

dataset = HDF5WaveformDataset(
    h5_file="data/hdf5/continuous_waveform_usa_*.h5",
    mode="three",
    allowed_families=("HH", "BH", "EH", "HN"),
    allow_z_only=True,
    replicate_z_only=True,
    target_sampling_rate=100.0,
)
print(f"文件数: {len(dataset.h5_files)}  |  样本数: {len(dataset)}")

目录:

dataset = HDF5WaveformDataset(h5_file="data/hdf5/", mode="three")

去除原始仪器响应:

dataset = HDF5WaveformDataset(
    h5_file="data/hdf5/continuous_waveform_usa_20190701.h5",
    mode="three",
    instrument_response_json="data/response/instrument_responses.json",
    remove_instrument_response=True,
    response_output="VEL",
    response_pre_filt=(0.2, 0.5, 20.0, 45.0),
    response_water_level=None,
)

去除原始响应后再仿真目标响应:

dataset = HDF5WaveformDataset(
    h5_file="data/hdf5/continuous_waveform_usa_20190701.h5",
    mode="single",
    instrument_response_json="data/response/instrument_responses.json",
    remove_instrument_response=True,
    response_output="VEL",
    response_pre_filt=(0.2, 0.5, 20.0, 45.0),
    response_water_level=None,
    simulate_instrument_response=True,
    simulation_response_selector={
        "network": "BK",
        "station": "BDM",
        "location": "00",
        "channel": "BHZ",
        "time": "2019-07-06T04:00:00Z",
    },
    simulation_output="VEL",
)

返回的样本中会包含 instrument_processing 字段,记录匹配到的原始 response_id、响应有效期、仿真目标响应 id 以及可能的处理错误。去响应和响应仿真使用 ObsPy 的响应计算能力;dataloader 负责提供 SeismicX-Cont JSON 响应查找和逐样本匹配。


5.5 DataLoader 配置

单进程(最安全 — MPS 必须用此模式):

from torch.utils.data import DataLoader

loader = DataLoader(
    dataset,
    batch_size=1,
    shuffle=False,
    num_workers=0,
    collate_fn=waveform_collate_fn,
)

多进程(推荐用于 CUDA):

h5py 不支持 fork。Linux 上 DataLoader 默认使用 fork,会导致 HDF5 读取出错甚至数据损坏。必须显式指定 spawn

from utils.hdf5_waveform_dataset import hdf5_worker_init_fn

loader = DataLoader(
    dataset,
    batch_size=4,
    shuffle=False,
    num_workers=4,
    collate_fn=waveform_collate_fn,
    multiprocessing_context="spawn",   # Linux 必须,避免 h5py + fork 死锁
    worker_init_fn=hdf5_worker_init_fn,
    prefetch_factor=2,
    persistent_workers=True,
    pin_memory=True,                   # 加速 CPU → GPU 数据传输
)

macOS 下 Python ≥ 3.8 默认已经是 spawn,无需额外设置。


5.6 续跑:跳过已处理样本

传入 skip_jsonl 参数,在读取任何波形数据之前从索引中移除已完成的样本:

dataset = HDF5WaveformDataset(
    h5_file="data/hdf5/continuous_waveform_usa_*.h5",
    mode="three",
    skip_jsonl="data/picks/output.jsonl",
    skip_record_type="phase_pick",
)
print(f"原始样本数 : {dataset.original_index_size}")
print(f"已完成     : {dataset.filtered_index_size}")
print(f"待处理     : {len(dataset)}")

启动时 JSONL 被分割为多个字节范围块,通过 ThreadPoolExecutor 并行扫描。每条完成记录的样本 key 直接由其字段(h5_fileyear_idday_idstation_idchannel_familychannels)重建,匹配的索引项在 __getitem__ 调用之前被移除。


5.7 样本输出字典

__getitem__(或经由 DataLoader 交付)的每个样本为 Python dict

{
    # 标识信息
    "mode": "three",
    "h5_file": "data/hdf5/continuous_waveform_usa_20190701.h5",
    "year_id": "2019-01-01T00:00:00.000000Z",
    "day_id":  "2019-07-01T00:00:00.000000Z",
    "station_id": "BK.BDM.00",

    # 通道信息
    "channel_family": "BH",
    "channels": ["BHE", "BHN", "BHZ"],   # 每个分量槽对应一个通道
    "component_order": "E/N/Z or 1/2/3",
    "is_z_only": False,
    "z_only_replicated": False,

    # 波形
    "waveform": torch.Tensor,            # 形状 [T, 3],float32
    "sampling_rate": 100.0,              # 重采样后的采样率(Hz)
    "original_sampling_rate": 40.0,
    "target_sampling_rate": 100.0,
    "resampled": True,
    "npts": 8640001,

    # 时间
    "starttime": "2019-07-01T00:00:00.000000Z",
    "endtime":   "2019-07-01T23:59:59.990000Z",

    # 台站元数据
    "station_info": {
        "station_id": "BK.BDM.00",
        "network": "BK",
        "station": "BDM",
        "location": "00",
        "longitude": -122.2486,
        "latitude":   37.8762,
        "elevation":  276.0,
        "location_available": True,
        "position_match_mode": "strict_time_matched_network_station_only",
        "position_is_fallback": False,
        "position_history": [...],
        ...
    },

    # 各通道元数据(以通道代码为 key)
    "channel_info": {
        "BHE": {"channel": "BHE", "segment_count": 3, "starttime": "...", ...},
        "BHN": {...},
        "BHZ": {...},
    },

    # 原始分段元数据(include_segments_metadata=False 时为空列表)
    "segments": [],
}

5.8 极简示例脚本

scripts/example_dataloader.py 在不到 90 行内演示了完整流程:

python scripts/example_dataloader.py \
  --h5_input data/hdf5/continuous_waveform_usa_20190701.h5 \
  --n_samples 3

示例输出:

── Sample 1 ──────────────────────────────────────────
  station_id    : BK.BDM.00
  network       : BK.BDM
  channels      : ['BHE', 'BHN', 'BHZ']
  starttime     : 2019-07-01T00:00:00.000000Z
  sampling_rate : 100.0 Hz
  waveform shape: (8640001, 3)  (86400.0 s  ×  3 分量)
  waveform dtype: torch.float32
  Z-only        : False
  location      : lon=-122.2486  lat=37.8762
  ch[E/1]  min=-1.234e-05  max=+2.345e-05  std=3.210e-06
  ch[N/2]  min=-1.100e-05  max=+1.987e-05  std=2.890e-06
  ch[Z/3]  min=-9.870e-06  max=+1.543e-05  std=2.654e-06

6. 推荐报告量

推荐在连续监测复用研究中至少报告以下量:

  • 声明的 C0--C3 覆盖层级,以及 NSLC、时间窗、分量、采样率、响应和缺口条件
  • coverage-aware recall — 在一对一匹配容限内命中的 coverage-qualified 参考震相比例
  • pick-centred matched fraction — 满足相型和阈值条件的自动拾取中被一对一匹配使用的比例
  • 自动拾取总量和单位时间 catalog-unmatched pick 数量;未匹配拾取不等同于确认的错误检测
  • 阈值、预处理、通道选择和 P/Pg/Pn、S/Sg/Sn 归一化规则
  • 需要进行时序诊断时使用的残差稳健统计

7. 数据产品设计理念

SeismicX-Cont 作为一个可复用的连续监测数据产品,提供不同条件下的报告视角:

  • 高频事件密度条件下,需要谨慎记录波形覆盖和参考标注分母;
  • 低事件率背景条件下,catalog-unmatched 自动拾取、台站覆盖和元数据完整性更加突出。

这种结构支持可复现报告和工作流诊断,但不意味着对独立训练的拾取系统进行 标准化或公平的模型比较。


8. 总结

SeismicX-Cont 提供处理后的连续波形数据库、覆盖元数据、CEED 衍生标注、 仪器响应元数据、验证脚本和可复用访问工具。它适合用于连续地震检测研究、 监测工作流诊断、震相关联实验和需要保留 provenance、coverage 与源数据引用边界的 大规模波形分析。


9. 波形索引 API 与数据查询(含 macOS 外接硬盘问题说明)

9.1 核心接口

from utils.waveform_index_api import query_and_merge

merged, rows = query_and_merge(
    db_file="data/index/waveform_index.sqlite",
    network="BK",
    station="BDM",
    location="*",
    channel="BH*",
    starttime="2019-07-01T00:00:00",
    endtime="2019-07-01T01:00:00",
    fill_value=0.0,
)

merged 是以 "network.station.location.channel" 为 key 的字典,每个值包含 data(ndarray)、sampling_ratestarttimeendtimefilled_ratiosegments。 同一个 API 也可以在返回数组前使用发布包中的仪器响应 JSON 做去响应:

merged, rows = query_and_merge(
    db_file="data/index/waveform_index.sqlite",
    network="BK",
    station="BDM",
    channel="BHZ",
    starttime="2019-07-01T00:00:00",
    endtime="2019-07-01T00:01:00",
    instrument_response_json="data/response/instrument_responses.json",
    remove_instrument_response=True,
    response_output="VEL",
    response_pre_filt=(0.2, 0.5, 20.0, 45.0),
    response_water_level=None,
)

启用响应处理后,每个返回的波形条目会包含 instrument_processing 元数据, 记录匹配到的原始 response_id、响应有效期、可选的目标仿真响应 id、 处理开关以及可能的错误信息。

9.2 通配符查询机制

* 在内部转换为 SQL LIKE (%)。支持:*(全匹配)、BK(精确匹配)、B*(前缀)、*Z(后缀)、BH*(通道族)。

9.3 构建 SQLite 索引

python utils/hdf5_waveform_index.py build \
  --h5 "data/hdf5/continuous_waveform_usa_*.h5" \
  --db data/index/waveform_index.sqlite

在外接硬盘上,推荐使用下面的封装脚本。它会先在本地临时目录构建 SQLite, 再把完成的数据库复制到 data/index/

./scripts/build_waveform_index.sh

9.4 示例脚本

python scripts/example_query_waveform.py \
  --db data/index/waveform_index.sqlite \
  --network BK --station BDM \
  --starttime 2019-07-01T00:00:00 \
  --endtime 2019-07-01T01:00:00

需要幅值相关读取时,可以在 SQLite 查询脚本中加入去响应或目标响应仿真:

python scripts/example_query_waveform.py \
  --db data/index/waveform_index.sqlite \
  --network BK --station BDM --channel BHZ \
  --starttime 2019-07-01T00:00:00 \
  --endtime 2019-07-01T00:01:00 \
  --remove_response \
  --response_pre_filt 0.2 0.5 20 45 \
  --response_water_level none

9.5 ⚠️ macOS 外接硬盘 SQLite 问题

SQLite 写操作需要文件锁和 journal/WAL 文件。外接硬盘(exFAT、NTFS、网络盘)往往缺乏可靠的锁机制,导致 sqlite3.OperationalError: attempt to write a readonly database,即使 HDF5 写入完全正常。

推荐方案: SQLite 索引放本地磁盘,HDF5 数据留在外接盘:

--h5 /Volumes/T5/publish/data/hdf5/*.h5  # HDF5 在 T5 项目盘
--db ~/waveform_index.sqlite     # SQLite 在本地

用以下命令验证 SQLite 可写性:

python -c "import sqlite3; sqlite3.connect('/tmp/seismicx_sqlite_test.db').execute('CREATE TABLE t(a)')"

10. 震相拾取:scripts/run_picker_to_jsonl.py

对 DataLoader 输出的每个样本运行 TorchScript 震相拾取模型,并将结果写入 JSONL 文件。支持 Mac/MPS、CUDA 和 CPU,自动选择设备,并内置续跑功能。


10.1 快速开始

Mac / Apple Silicon(MPS):

python scripts/run_picker_to_jsonl.py \
  --h5_input 'data/hdf5/continuous_waveform_usa_*.h5' \
  --output_jsonl data/picks/output.jsonl \
  --picker_model pickers/pnsn.v1.jit \
  --polar_model pickers/polar.onnx \
  --device mps

CUDA(多进程预取):

python scripts/run_picker_to_jsonl.py \
  --h5_input 'data/hdf5/continuous_waveform_usa_*.h5' \
  --output_jsonl data/picks/output.jsonl \
  --picker_model pickers/pnsn.v1.jit \
  --polar_model pickers/polar.onnx \
  --device cuda \
  --batch_size 4 \
  --num_workers 4 \
  --prefetch_factor 2

续跑中断任务(默认开启):

直接重新运行相同命令即可。脚本在启动时扫描已有 JSONL,重建已完成样本的 key 集合,并在读取任何波形数据之前将其从 DataLoader 索引中移除。


10.2 命令行参数

参数 默认值 说明
--h5_input data/hdf5/continuous_waveform_usa_*.h5 HDF5 文件、目录或通配符
--output_jsonl data/picks/output.jsonl 输出 JSONL 文件(续跑模式下追加)
--picker_model pickers/pnsn.v1.jit TorchScript 震相拾取器(.jit
--polar_model pickers/polar.onnx 可选 ONNX 极性模型;传 "" 关闭
--device auto 推理设备:autocpucudamps
--batch_size 1 DataLoader batch 大小;样本仍逐个处理
--num_workers 0 DataLoader 工作进程数;0 = 单进程(MPS 必须)
--prefetch_factor 2 每个 worker 预加载的 batch 数(num_workers=0 时忽略)
--multiprocessing_context auto auto 在 Linux 上自动选择 spawn;可手动指定 spawnforkforkserver
--allowed_families HH,BH,EH,HN 逗号分隔的通道族列表
--allowed_z_only_channels EHZ 逗号分隔的 Z-only 通道代码
--allow_z_only / --no_z_only True 是否包含 / 排除 Z-only 台站
--replicate_z_only / --no_replicate_z_only False 是否显式启用 Z-only 到 [Z,Z,Z] 的复制
--target_sampling_rate 100.0 目标采样率(Hz);-1 关闭重采样
--min_confidence 0.0 写入的最低拾取概率
--snr_window_sec 2.0 拾取前后 SNR 计算窗口长度(秒)
--progress_interval 100 每 N 个样本打印一次进度
--flush_interval 1000 每 N 个样本 flush JSONL;0 仅在结束时 flush
--gc_interval 200 每 N 个样本执行 gc.collect + 清空设备缓存
--resume / --no_resume True 开启 / 关闭续跑模式
--mps_empty_cache_interval 1 每 N 个样本调用 torch.mps.empty_cache()
--cuda_empty_cache_interval 200 每 N 个样本调用 torch.cuda.empty_cache()
--reload_model_interval -1 每 N 个样本重新加载模型;-1 = 自动(MPS 为 50,CUDA/CPU 为 0)
--include_segments_metadata False 在 loader 输出中包含原始 HDF5 分段字典
--no_keep_h5_open 禁用每个文件的 HDF5 句柄缓存
--no_overlap_mask 禁用分段合并中的重叠掩码
--h5_rdcc_nbytes 8388608(8 MB) 每个文件句柄的 HDF5 chunk 缓存大小(字节)
--max_samples 0 处理 N 个新样本后以退出码 75 退出;加 --resume 重启可继续。0 = 不限制。详见下方 MPS 重启循环。

10.3 各设备注意事项

MPS(Mac / Apple Silicon)

必须使用 --num_workers 0(单进程)。MPS TorchScript allocator 的 Metal buffer 状态随每次 sess(xt) 调用累积,torch.mps.empty_cache() 无法完全回收。脚本默认每 50 个样本重新加载一次模型(--reload_model_interval -1)以重置 allocator 状态。对于很短的波形,可适当增大该间隔以减少重载开销;设为 --reload_model_interval 0 可完全关闭。

对于长时间运行(数千个样本),即使反复重载模型也无法完全回收 Metal allocator 的进程级状态。推荐使用 --max_samples + 重启循环,借助进程退出让 OS 彻底回收内存:

while true; do
  python scripts/run_picker_to_jsonl.py \
    --h5_input 'data/hdf5/continuous_waveform_usa_*.h5' \
    --output_jsonl data/picks/output.jsonl \
    --picker_model pickers/pnsn.v1.jit \
    --polar_model pickers/polar.onnx \
    --device mps --max_samples 200
  [ $? -ne 75 ] && break
done

脚本在达到 --max_samples 限制时以退出码 75 退出,全部完成时以退出码 0 退出。--resume 默认启用,每次重启均在数据集层面跳过已写入样本(不会重复从 HDF5 读取波形数据)。

CUDA

推荐使用 --num_workers 4 或更多,以并行化 HDF5 I/O 和 GPU 推理。Linux 上自动选择 spawn 上下文。CUDA allocator 不存在 TorchScript 状态积累问题,默认关闭模型重载。

CPU

单进程运行,无需特殊内存管理。


10.4 续跑机制

启动时脚本向 HDF5WaveformDataset 传入 skip_jsonl=output_jsonl。JSONL 被分割为多个字节范围块,通过 ThreadPoolExecutor 并行扫描。每条完成记录的样本 key 直接由其字段(h5_fileyear_idday_idstation_idchannel_familychannels)重建,匹配的索引项在 DataLoader 的任何 __getitem__ 调用之前被移除,对应的波形数据永远不会从 HDF5 读取。

对于超大 JSONL 文件(>10 GB),启动扫描可能需要 30–120 秒,但远少于重新推理的代价。


10.5 输出 JSONL 格式

每行输出一条独立的 JSON 记录,有两种 record_type

"phase_pick" — 每个检测到的震相一条记录:

{
  "record_type": "phase_pick",
  "phase_id": 0,
  "phase_name": "Pg",
  "phase_prob": 0.987,
  "phase_sample": 15234.0,
  "phase_relative_time": 152.34,
  "phase_time": "2019-07-01T00:02:32.340000Z",
  "polarity": "U",
  "polarity_prob": 0.912,
  "polarity_available": true,
  "snr": 12.4,
  "amplitude": 3.14e-05,
  "pre_std": 2.10e-06,
  "post_std": 2.60e-05,
  "pre_abs_p95": 4.11e-06,
  "post_abs_p95": 5.87e-05,
  "channels": ["BHE", "BHN", "BHZ"],
  "channel_family": "BH",
  "component_order": "E/N/Z or 1/2/3",
  "is_z_only": false,
  "z_only_replicated": false,
  "waveform_shape": [8640001, 3],
  "sampling_rate": 100.0,
  "original_sampling_rate": 40.0,
  "target_sampling_rate": 100.0,
  "resampled": true,
  "h5_file": "data/hdf5/continuous_waveform_usa_20190701.h5",
  "year_id": "2019-01-01T00:00:00.000000Z",
  "day_id":  "2019-07-01T00:00:00.000000Z",
  "station_info": {
    "station_id": "BK.BDM.00",
    "network": "BK",
    "station": "BDM",
    "location": "00",
    "longitude": -122.2486,
    "latitude":   37.8762,
    "elevation":  276.0,
    "location_available": true,
    "position_in_time_range": true,
    "position_is_fallback": false
  }
}

"error" — 推理失败的样本记录一条错误:

{
  "record_type": "error",
  "station_id": "BK.BDM.00",
  "h5_file": "...",
  "year_id": "...",
  "day_id": "...",
  "sample_key": "...|...|...|...|BH|BHE,BHN,BHZ",
  "error": "RuntimeError: ..."
}

phase_id → phase_name 对应关系:

phase_id phase_name
0 Pg
1 Sg
2 Pn
3 Sn
4 P
5 S

11. 拾取评估:essd_scripts/evaluate_picks.py

将自动生成的震相拾取结果与保留来源信息的参考标注进行匹配;参考标注明确区分 人工与业务自动子集。SQLite 索引用于处理 40 GB 以上的 JSONL 文件。可选目录 data/validation/multimodel_phase_matching/ 中的匹配记录用于数据产品可用性和 格式互操作检查,不是相对模型评估证据;其大体量源自动拾取 JSONL 不属于该 版本化扩展。


11.1 工作流程

第一步 — 构建 SQLite 索引(首次运行):

python essd_scripts/evaluate_picks.py \
  --auto-jsonl  data/picks/output.jsonl \
  --index-db    ~/output.index.sqlite \
  --build-index \
  --drop-existing

流式读取 JSONL,批量插入 SQLite(每批 50,000 条),并为 (station_id, phase_name, sec_key)time_epoch 建立索引。索引文件通常比原始 JSONL 小 3–5 倍。 如果更新了源 JSONL 后重新构建索引,请使用 --drop-existing,避免旧拾取记录被保留。

第二步 — 评估召回率和残差:

python essd_scripts/evaluate_picks.py \
  --auto-jsonl  data/picks/output.jsonl \
  --label-json  data/label/annotations_for_continuous_hdf5.json \
  --reference-db data/label/reference_arrivals.sqlite \
  --index-db    ~/output.index.sqlite \
  --outdir      eval_picks/eval_phasenet \
  --tp-tol      1.5 \
  --err-window  5.0

第三步 — 增加可选的目录条件化参考窗输出诊断:

python essd_scripts/evaluate_picks.py \
  --auto-jsonl  data/picks/output.jsonl \
  --label-json  data/label/annotations_for_continuous_hdf5.json \
  --reference-db data/label/reference_arrivals.sqlite \
  --index-db    ~/output.index.sqlite \
  --outdir      eval_picks/eval_phasenet \
  --tp-tol      1.5 \
  --coverage-level C0 \
  --output-eligibility-db data/label/output_eligibility.sqlite \
  --output-name phasenet \
  --reference-window-s 5 \
  --reference-window-s 30

每个 --reference-window-s 值都是窗口半宽 T,且不得小于一对一匹配容限 epsilon = --tp-tol。程序采用与召回率相同的 C0--C3 覆盖配置,只保留位于指定 输出处理域内的人工参考震相,按精确台站位置和归一化震相合并 +/-T 窗口,再与 该输出的处理域取交集。输出包括目录条件化匹配比例、原始参考窗时长、有效处理窗 时长、eligible 参考数、匹配数和目录未匹配数。该量是 precision-oriented 的输出 诊断,不是传统完整连续流 precision 的估计。报告时必须同时声明覆盖等级、输出 处理域、Tepsilon

第四步 — 生成图表(可选,需要 matplotlib + scipy):

python essd_scripts/evaluate_picks.py \
  --auto-jsonl  data/picks/output.jsonl \
  --label-json  data/label/annotations_for_continuous_hdf5.json \
  --reference-db data/label/reference_arrivals.sqlite \
  --index-db    ~/output.index.sqlite \
  --outdir      eval_picks/eval_phasenet \
  --plot

查看索引统计:

python essd_scripts/evaluate_picks.py \
  --index-db ~/output.index.sqlite \
  --db-info

11.2 命令行参数

参数 默认值 说明
--auto-jsonl data/picks/skynet.phase.jsonl scripts/run_picker_to_jsonl.py 的输出 JSONL
--label-json data/label/annotations_for_continuous_hdf5.json 保留人工/业务自动来源的 CEED 格式标注 JSON
--reference-db None reference_arrivals.sqlite 中的版本化 C0--C3 标志;与 --waveform-db 互斥
--index-db ~/skynet.pick.index.sqlite SQLite 索引路径(建议放本地磁盘,见第 9.5 节)
--outdir eval_picks/eval_skynet 输出文件目录
--build-index 开关 流式读取 JSONL 并构建 / 更新 SQLite 索引
--drop-existing 开关 重建前删除现有索引表
--keep-raw-json 开关 在 SQLite 中存储完整原始 JSON(大文件不推荐)
--batch-size 50000 索引构建时的 SQLite 批量插入大小
--tp-tol 1.5 真正例(TP)判定容限(秒)
--err-window 5.0 残差分布统计的更宽搜索窗口(秒)
--coverage-level C0 召回率与参考窗诊断共同采用的覆盖配置(C0--C3
--output-eligibility-db 参考窗诊断所需的输出台站-时间处理域 SQLite
--output-id--output-name 被评估输出的精确选择器;参考窗诊断必须二选一
--reference-window-s 可选目录条件化参考窗匹配比例的半宽 T;可重复指定以报告敏感性
--min-prob None 自动拾取的最低 phase_prob 阈值
--phase-map None 标注震相到自动震相的映射(见下文)
--plot 开关 生成残差分布直方图和召回率柱状图
--db-info 开关 打印索引中的拾取数量后退出

11.3 目录条件化参考窗匹配比例

对于精确台站位置 s 和归一化震相 phi,程序先选择满足声明的 C0--C3 覆盖 条件且位于被评估输出 eligibility 区间内的人工参考震相。合并 [t_r-T, t_r+T] 后,再将窗口并集与相同 eligibility 区间取交集。分子是 epsilon 内确定性一对一匹配数,分母是有效处理窗内的全部自动拾取;其余分母 拾取属于目录未匹配项,不能直接判定为错误检测。

T 较小时,该比例强烈依赖已知参考震相;随着 T 增大,会纳入更多连续输出, 但目录不完备性的影响也会增强。因此它是输出审计诊断,而不是传统 precision。 复用时必须保持覆盖、波形、参考与工作流处理域、预处理、阈值、震相映射、Tepsilon 和一对一匹配规则一致,并同时报告原始参考窗时长和有效处理窗时长。


11.4 震相映射(Phase Map)

--phase-map 参数控制标注震相名称与自动拾取震相名称的匹配方式。默认归一化为:

P  → P, Pg, Pn
S  → S, Sg, Sn
Pg → Pg
Sg → Sg
Pn → Pn
Sn → Sn

在同一台站、归一化震相和标注子集中使用一对一匹配;同一条自动拾取不能同时匹配两条参考标注。确定性的时间有序分配先最大化真阳性容限内的匹配数,再考虑较宽诊断窗内的匹配数和总绝对残差。

用分号分隔的列表自定义:

# 标注 P 可匹配 Pg 或 Pn;标注 S 可匹配 Sg 或 Sn
--phase-map "P:Pg,Pn;S:Sg,Sn"

# 严格匹配:标注 P 只匹配 Pg
--phase-map "P:Pg;S:Sg"

11.5 标注 JSON 格式

标注文件采用嵌套结构:

years → days → events → stations → picks[]

每条拾取记录最少需要包含:

{
  "phase": "P",
  "time":  "2019-07-01T00:02:32.340000Z",
  "status": "manual",
  "station_id": "BK.BDM.00"
}

可选字段:networkstationlocationevent_iddistance_km


11.6 输出文件

所有输出写入 --outdir

文件 说明
summary.json 各震相和子集的召回率、残差和自动拾取统计,以及声明覆盖与工作流处理域的可选目录条件化参考窗匹配比例
summary.tsv summary.json 相同的内容,以制表符分隔,每行对应一个(子集,震相)组合
matches.jsonl 每个标注拾取对应一行:是否匹配、残差(秒)、自动拾取概率、信噪比
figures/residual_fit_{subset}_{phase}.png 残差直方图,叠加高斯和 Student-t 拟合 PDF
figures/recall_bar.png 各震相和子集的召回率柱状图
figures/auto_pick_count_bar.png 按震相名称分组的自动拾取数量柱状图

报告子集: all(全部标注拾取)、manual(手动审核)、automatic(自动标注)。

summary.json 结构(摘录):

{
  "tp_tolerance_s": 1.5,
  "residual_window_s": 5.0,
  "label_phase_count_all_status": {"P": 1240, "S": 1198},
  "subsets": {
    "all": {
      "P": {
        "n_label": 1240,
        "n_matched_within_tp_tol": 1102,
        "recall": 0.889,
        "residual_mean_s": 0.031,
        "residual_std_s": 0.214,
        "residual_median_s": 0.018,
        "residual_abs_p90_s": 0.45,
        "gaussian_fit_all_within_err_window": {"mean": 0.031, "std_mle": 0.213, "std_unbiased": 0.213},
        "student_t_fit_all_within_err_window": {"df": 4.2, "loc": 0.029, "scale": 0.18}
      }
    }
  },
  "auto_pick_count": {
    "total": 458320,
    "by_auto_phase": {"Pg": 231044, "Sg": 198210, "Pn": 18700, "Sn": 10366},
    "mapped_to_label_phase": {"P": 231044, "S": 198210}
  }
}

12. REAL 关联:scripts/run_real_association.py

scripts/run_real_association.py 用来连接 SeismicX-Cont 的 picker JSONL 格式和 REAL 关联算法。脚本会编译 scripts/real/real.c,将自动拾取震相 归一化为 P/S,生成 REAL 输入文件,运行基于关联的事件检测,并将结果导出为 同时包含时间窗震相候选和关联事件的 workflow JSONL。该输出可直接用于事件 检测评估,也可以通过关联震相列表交给使用者自己的地震定位程序。

python scripts/run_real_association.py \
  --picks-jsonl data/picks/pnsn_v3_diff.phase.jsonl \
  --output-jsonl data/associated/real_events.jsonl \
  --starttime 2019-07-01T00:00:00Z \
  --endtime 2019-07-08T00:00:00Z

输出文件 data/associated/real_events.jsonl 包含一条 real_association_run 元信息记录、每个进入 REAL 的时间窗震相候选 real_input_pick 记录,以及每个关联事件 real_event 记录。事件中的每条 关联震相都包含 source_pick.real_input_pick_id,可回指到对应的时间窗震相, 再追溯到原始 picker JSONL 行号、台站信息、拾取概率、通道族和源 HDF5 文件。 旁边的 real_events.summary.json 记录筛选数量和 REAL 运行命令。

默认参数是用于跑通端到端流程的保守设置,不是最终编目生产参数。针对具体 picker、时间段和速度模型,可调整 --min-prob--real-s--real-r--real-g。更详细的说明见 scripts/README_real_association.md

关联 JSONL 有意保持简单。下游定位程序可以忽略 REAL 特有的诊断字段,只读取 real_event.picks[]:其中每条关联震相都包含台站、震相名、拾取时间,以及 回指到原始自动拾取记录的链接。如果关联器提供了初步的 latitudelongitudedepth_km 字段,脚本会保留;但这些字段不是对接下游定位 流程的必需条件。

12.1 地震事件级目录对比

使用 essd_scripts/compare_associated_events.py 可以将关联得到的地震事件与 SeismicX-Cont 目录或任意符合格式约定的 event JSONL 进行对比:

python essd_scripts/compare_associated_events.py \
  --pred-jsonl data/associated/real_events.jsonl \
  --catalog data/label/annotations_for_continuous_hdf5.json \
  --outdir eval_events/real_vs_catalog

当关联事件与参考目录事件满足震中距误差 < 20 km 且发震时刻误差 < 3 s 时,计为一个 TP 地震样本。脚本输出事件级 precision、recall、F1、相对于参考目录的 apparent false positives 和 false negatives,以及时间、位置、深度和震级误差统计。通用 event JSONL 格式见 essd_scripts/README_event_comparison.md


13. 许可、引用与校验清单

许可按发布层分开说明。完整条款见 LICENSELICENSE_CLARIFICATION.md

  • HDF5 波形数据库产品是由源波形记录处理和结构化得到的衍生产品。该处理后 HDF5 波形层的发表和再分发已与相关美国地震数据提供方澄清,使用范围限于 非商业科学研究,并遵循与上游兼容的数据使用条款。
  • SeismicX-Cont 作者生成的元数据 schema、文档、manifest、验证摘要、图件和 复用说明采用 CC BY 4.0
  • scripts/essd_scripts/utils/ 和 notebooks 中的代码采用 MIT License

HDF5 产品中的波形数组不由 SeismicX-Cont 重新授权为 CC BY 4.0。用户必须遵守 源数据提供方条款,并在适当情况下同时引用 SeismicX-Cont、SCEDC、NCEDC、 CEED 和贡献台网来源。

发布版本记录在 VERSION 中;正式发布时也应使用相同版本号作为 tag,例如 v1.0.0。机器可读引用元数据见 CITATION.cff

主数据集的 SHA256 校验清单和文件大小清单可用下面的命令重新生成:

./scripts/write_manifest.sh

该脚本会写出 manifest_sha256.txtmanifest_filesizes.tsv,并排除本地构建产物、 论文文件、生成图件、mini 发布文件、临时文件、picker 输出和小时级中间子集。 HuggingFace 和 ModelScope 仓库使用同一组 manifest 对齐,因此任一平台的 下载都可以用相同的路径、SHA-256 校验值和文件大小进行核验。

ESSD 论文表格和图可用下面的一键命令从发布数据和评估输出中复现:

./essd_scripts/reproduce_manuscript_outputs.sh

该命令会把审计结果写入 essd_scripts/outputs/,并重建 figures/ 下的论文图件。


联系方式

SeismicX 由以下人员开发:


Built with ❤️ for the seismology community