引言

SIMPLON API 概述

核心設計理念

1. RESTlike 架構：每個探測器資源（配置參數、狀態、命令）都通過URL 進行標識

2. 語義化 HTTP 方法：使用 GET 讀取參數、PUT 修改配置或執行命令、DELETE 刪除資源

3. 自描述性：所有參數都包含數據類型、取值范圍、單位和訪問權限信息

4. 一致性：EIGER2、PILATUS 和 POLLUX 系列探測器共享相同的 API 接口

版本控制

• 主版本號：不兼容的 API 變更

• 次版本號：向后兼容的功能新增

• 補丁號：向后兼容的問題修正

API 核心架構

URL 結構

• <DCU_IP>：探測器控制單元（Detector Control Unit）的 IP 地址

• <module>：功能模塊（detector、monitor、filewriter、stream、system）

• <version>：API 版本號（如 1.8.0）

• <task>：操作類型（config、status、command）

• <parameter>：具體參數或命令名稱

主要功能模塊

數據格式

核心子系統詳解

1. 探測器子系統（Detector）

關鍵配置參數

• 曝光控制：count_time（曝光時間）、frame_time（幀周期）、nimages（圖像數量）、trigger_mode（觸發模式）

• 能量設置：photon_energy（光子能量）、threshold_energy（閾值能量）

• 校正功能：flatfield_correction_applied、countrate_correction_applied、pixel_mask_applied

• 幾何參數：detector_distance（探測器距離）、beam_center_x/beam_center_y（束斑中心）

• 高級功能：compression（壓縮算法）、roi_mode（感興趣區域）、binning_mode（像素合并）

重要控制命令

• initialize：初始化探測器（上電或服務重啟后必須執行）

• arm：加載配置并準備采集

• trigger：軟件觸發采集

• disarm：結束采集并寫入所有數據

• abort：立即中止所有操作

2. 監控子系統（Monitor）

主要特性

• 可配置的緩沖區大小（默認 100 幀）

• 支持 TIFF 格式圖像輸出

• 包含完整的元數據（曝光時間、能量、束斑中心等）

• 超時機制防止請求掛起

3. 文件寫入子系統（FileWriter）

關鍵配置

• mode：啟用 / 禁用文件寫入

• name_pattern：文件式（支持$id變量）

• nimages_per_file：每個數據文件的最大圖像數

• compression_enabled：啟用 / 禁用數據壓縮

• format：HDF5 文件格式

4. 流子系統（Stream）

• Stream V1：基于 ZeroMQ 的多部分 JSON 消息（端口 9999）

• Stream V2：基于 CBOR 編碼的單部分消息（端口 31001），性能更高，延遲更低

Stream V2 優勢

• 單消息設計，減少網絡開銷

• CBOR 編碼比 JSON 更緊湊、解析更快

• 支持多客戶端連接（輪詢分發）

• 包含完整的元數據和圖像數據

5. 系統子系統（System）

• 網絡配置（IP 地址、DNS、MTU 等）

• 日期時間設置（NTP 同步、時區）

• 系統命令（重啟、關機、日志收集）

完整數據采集流程

1. 初始化探測器
   python
2. import requestsimport json

   DCU_IP = "192.168.0.100"API_VERSION = "1.8.0"# 初始化探測器response = requests.put(f":///detector/api//command/initialize", json={})response.raise_for_status()

3. 配置采集參數
   python
4. # 設置曝光時間為0.1秒response = requests.put(

       f":///detector/api//config/count_time",    json=)

5. # 設置采集100幀圖像response = requests.put(    f":///detector/api//config/nimages",    json=)

6. # 設置觸發模式為內部觸發response = requests.put(    f":///detector/api//config/trigger_mode",    json=)

7. 配置數據接口
   python
8. # 啟用FileWriterresponse = requests.put(

       f":///filewriter/api//config/mode",    json=)

9. # 設置文件模式response = requests.put(    f":///filewriter/api//config/name_pattern",    json=)

10. 啟動采集
    python
11. # Arm探測器response = requests.put(f":///detector/api//command/arm", json={})sequence_id = response.json()["sequence_id"]
12. # 觸發采集response = requests.put(f":///detector/api//command/trigger", json={})
13. 等待采集完成并下載數據
    python
14. # 等待采集完成（實際應用中應輪詢狀態）import time

    time.sleep(15)

15. # Disarm探測器response = requests.put(f":///detector/api//command/disarm", json={})

16. # 下載HDF5文件master_file = requests.get(f":///data/my_experiment__master.h5")with open(f"my_experiment__master.h5", "wb") as f:    f.write(master_file.content)data_file = requests.get(f":///data/my_experiment__data_000001.h5")with open(f"my_experiment__data_000001.h5", "wb") as f:    f.write(data_file.content)

高級特性

多閾值能量分辨

高效數據壓縮

• LZ4：通用高速壓縮算法

• BSLZ4：DECTRIS 優化的位洗牌 + LZ4 算法，壓縮比更高，推薦用于全幀率采集

精確幾何坐標系統

• 實驗室坐標系：原點在樣品中心，Z 軸沿入射束方向，Y 軸向上

• 探測器坐標系：原點在傳感器左上角，X 軸沿快速掃描方向，Y 軸沿慢速掃描方向

北京泰坤：您的 DECTRIS 工業應用合作伙伴

1. 專業的技術咨詢：根據您的應用需求，推薦最合適的 EIGER2、PILATUS 或 POLLUX 探測器型號

2. 系統集成服務：將 DECTRIS 探測器無縫集成到您的工業檢測系統中

3. API 開發支持：提供 SIMPLON API 的技術培訓和定制化開發服務

4. 本地化技術支持：快速響應您的技術問題，提供現場安裝和維護服務

5. 備件和維修服務：建立了備件庫，確保您的系統持續穩定運行

總結