Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all \x3Cpre>\x3Ccode> blocks (function() { function addCopyButtons() { document.querySelectorAll('pre code').forEach(function(codeBlock) { if (codeBlock.parentElement.hasAttribute('data-copy-added')) return; codeBlock.parentElement.setAttribute('data-copy-added', 'true'); var btn = document.createElement('button'); btn.textContent = 'Copy'; btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;'; btn.onmouseover = function() { this.style.opacity = '1'; }; btn.onmouseout = function() { this.style.opacity = '0.7'; }; btn.onclick = function() { navigator.clipboard.writeText(codeBlock.textContent).then(function() { btn.textContent = 'Copied!'; setTimeout(function() { btn.textContent = 'Copy'; }, 1500); }); }; codeBlock.parentElement.style.position = 'relative'; codeBlock.parentElement.appendChild(btn); }); } addCopyButtons(); // Re-run on dynamic content var observer = new MutationObserver(addCopyButtons); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + ' GitHub - khsacc/bl18c_controller: Python-based platform for BL-18C, Photon Factory, KEK, Japan · GitHub
Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - khsacc/bl18c_controller: Python-based platform for BL-18C, Photon Factory, KEK, Japan · GitHub
Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - khsacc/bl18c_controller: Python-based platform for BL-18C, Photon Factory, KEK, Japan · GitHub
Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - khsacc/bl18c_controller: Python-based platform for BL-18C, Photon Factory, KEK, Japan · GitHub
Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - khsacc/bl18c_controller: Python-based platform for BL-18C, Photon Factory, KEK, Japan · GitHub
Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - khsacc/bl18c_controller: Python-based platform for BL-18C, Photon Factory, KEK, Japan · GitHub
Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - khsacc/bl18c_controller: Python-based platform for BL-18C, Photon Factory, KEK, Japan · GitHub
Skip to content

Repository files navigation

BL-18C Controller

高エネ研 PF BL-18Cにおける実験機器制御のための Python ベース GUI アプリケーションです。

バグ報告や改善・機能の追加の提案は、GitHub の Issues または E-mail でお願いいたします。

現在制御可能な機器

用途製品通信様式
ステージ制御用ステッピングモーターコントローラーTsujicon PM16C-04XDLTCP/IP (内部ネットワーク)
試料観察用カメラI-O Data GV-USB2/HQUSB
イオンチャンバー/フォトダイオード電圧値読み出し用デジタルマルチーメーターKeithley 2000GPIB-USB
X線回折測定用CMOSフラットパネル検出器Teledyne Rad-icon 2022CameraLink, 26 pin High Density Mini-D Ribbon (MDR) connectors
低温実験用温度制御装置Lakeshore Model 335 cryogenic temperature controllerGPIB-USB
メンブレン駆動DAC用ガス圧制御装置Druck (Baker Hughes) PACE5000TCP/IP (内部ネットワーク)

アプリケーション

Note

それぞれのアプリの使用前に、詳細な仕様をご確認ください。

ステージ制御を主たる目的とするもの

  • Microscope + FPD stage control
    • 顕微鏡ステージ(Ch6, 7, 8)および検出器ステージ(Ch9)を制御する。
    • 顕微鏡ステージのIN位置およびOUT位置(Ch8)、検出器ステージのIN位置およびOUT位置(Ch9)を記憶し、ショートカットとして、1クリックでXRD測定と試料観察を切り替える。
    • 詳細な仕様は こちら
  • Interactive camera
    • カメラ画像を基に、主に試料ステージ(Ch3,4,5)を動かし、試料位置の調整およびオートフォーカスを行う。カメラ画像中におけるX線ビーム位置やレーザースポット位置を記録し、その位置に試料を動かすことが可能。カメラ画像にオーバーレイとして図形を書き込んで視覚的補助とすることもできる。また、補助的に、Ch7も一部操作することができる。
    • 試料観察用カメラとして、静止画の取得および動画の撮影と保存の機能を備えている。
    • 低温実験中、冷凍機の伸び縮みによって試料位置が変化するが、画像認識を用いて位置のずれを定量化し、ステージを動かして補正することで、試料位置を見失わないようにできる(Follow sample position)。
    • 詳細な仕様は こちら(工事中)。また、どのようにして画像認識を行っているかについて、簡単な技術的背景を Interactive camera で用いられている画像認識手法に関して にまとめているので、併せて参照いただきたい。
  • Simple controller for all stages
    • 全てのステージをパルス数ベースで制御する。ユーザーは目的のパルス数の絶対値、ないし現在値からの相対値を入力し、ステージを動かす。ステージ移動にある程度習熟しているユーザー向け。
    • 詳細な仕様は こちら
  • DAC stage oscillation
    • 二つのCh11位置(Pos A, Pos B)を定義し、その間を指定された回数往復する。
    • 詳細な仕様は こちら

スキャン

Tip

いずれのスキャンにも、得られたシグナルを函数フィットする機能が備えられている。フィッティング関数として、Gaussian および Aperture (erf + flat) が使える。 両者の比較は DAC scanの仕様書 を参照のこと。

  • Collimator scan
    • Ch1およびCh2をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (normal)
    • Ch4およびCh5をスキャンしながら透過X線強度を取得し、フィッティングにより最適位置の推定を行う。
    • 詳細な仕様は こちら
  • DAC scan (rotation centre)
    • Ch11を変化させながらCh10をスキャンすることで、幾何学的に試料中心と回転中心の位置のズレを計算し、両者を一致させるのに必要なCh3およびCh4の移動量を推定する。
    • 幾何学的な背景を含む、詳細な仕様はこちら
  • DAC scan (XRD)
    • Ch4およびCh5をスキャンしながらFPDでX線回折強度を測定し、即時1次元化したうえで、ユーザーの指定した $2\theta$ 領域の回折強度でマッピングする。
  • General 1D scan
    • 任意の並進ステージを選択し、透過X線強度をステージ位置の関数として取得し、フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら
  • General 2D scan
    • 任意の並進ステージを2つ選択し、透過X線強度によるマッピングと、各軸方向の Gaussian または erf フィッティングによる最適位置の推定を行う。
    • 詳細な仕様は こちら

X線回折データ取得に関連するもの

  • Rad-icon 2022 (FPD) controller
    • CMOSフラットパネル検出器 Rad-icon 2022 の制御を行う。
    • 検出器幾何校正を本プラットフォーム内部で行うことで、取得したデータの即時1次元化も可能
  • Calibrate detector geometry
    • 検出器幾何校正のためのアプリケーション。カメラ長を変えた標準試料データの取得(ないし既存データ読み出し)と、検出器幾何パラメータの最適化を行う。
    • 詳細な仕様は こちら

試料環境の制御に関連するもの

  • Druck PACE5000 controller "PaceMaker"
    • メンブレン駆動DAC用ガス圧制御装置 Druck PACE5000 の制御および値の読み出し、ログ取りを行う。
    • 詳細な仕様は こちら
    • このアプリケーションは、単体(スタンドアロン)でも起動でき、BL-18C 以外でも利用できる。→ https://github.com/khsacc/PaceMaker
  • LakeShore 335 controller
    • 低温実験用温度コントローラ LakeShore 335 の制御と値の読み出し、ログ取りを行う。

実験の自動化を目的としたもの

  • Experimental Scheduler
    • 本プラットフォームで制御可能な全ての機器を組み合わせて、自動実験を計画し実行する。

ログの保存

ステージ操作のログ

実機のPM16Cコントローラーへ接続すると、接続状態、ステージの操作・停止コマンド、移動結果、通信エラーおよび定期的な全チャンネルの状態がJSONL形式で記録される。ログは設定された詳細ログ保存先の stage_audit ディレクトリ以下に保存される。通常の状態監視用 STSx? 通信はログ容量を抑えるためファイルへ常時保存せず、直近10分間のみメモリ上に保持する。

指示のないパルス値変化や停止未確認を検出した場合は、異常前10分間と異常後最大60秒間の詳細な通信履歴をインシデントログとして別途保存する。イベントの種類、JSONLフォーマット、保存期間などの詳細は PM16Cの実装詳細 を参照のこと。

XRDデータの解析に関する機能

CMOS 型フラットパネル検出器 Rad-icon 2022 で取得されたX線回折画像に対する基本的な解析機能を備えている。本プログラム内での解析には、Pythonを用いた2次元X線回折データ解析ライブラリである PyFAI を用いている(Kieffer and Karkoulis (2013a), Kieffer and Karkoulis (2013b))。 PyFAI の検出器幾何は公式ドキュメントの General Introduction > Image representation in Python > Default geometry in pyFAI および Example of usage > Tutorials > Geometries in pyFAI に記載されているとおりである。

PyFAI の検出器幾何校正ファイルは PONI ファイルと呼ばれる。PONI ファイルは、アプリ内の Settings > Detector Calibration から登録することができ、一度登録すると、本アプリ内のあらゆるサブアプリケーションから即時読み出せるようになる。また、 PONI ファイルを作成するための機能も備えており、Calibrate detector geometry アプリケーションから行える。

BL-18C のユーザーが多く利用している IPAnalyzer (瀬戸ら (2010), Source: seto77/IPAnalyzer) における検出器幾何の定義は、 PyFAI のそれとは異なり、またパラメータファイル自体の形式も異なるため、そのままでは流用することはできない。これに対応するため、 Calibrate detector geometry アプリケーションの内部では、pyFAI での処理に用いる PONI ファイルに加えて、 IPAnalyzer での処理に必要な prm ファイルを同時に作成する機能を用いている。具体的には、 pyFAI の検出器幾何定義をIPAでの定義に変換する変換式を用い、 pyFAI で最適化された検出器幾何パラメータを数値的に変換してファイルを作成している。 PyFAI の PONI ファイルと、 IPAnalyzer の prm ファイル間の変換については、別ドキュメント にまとめているので、必要な場合は参照されたい。

PyFAI を用いた処理は、具体的には以下のアプリで用いられている。

  1. DAC Scan (XRD): 特定の物質の Bragg 反射の強度をもとにマッピングを行う。試料ステージを動かしながら、 FPD で XRD データを取得し、それを pyFAI を用いて即時1次元化し、ある散乱角 $2\theta$ 領域(ROI)の強度を抽出する。
  2. Rad-icon 2022 (FPD) controller: オプション機能として、得られたデータを即時2次元化し、CSV, TSV, GSAS (.gsa), Z-Rietveld (.histogramIgor) 形式で画像と保存する機能を備えている。オプション機能を利用するときは、 pyFAI に対応した校正情報(PONIファイル)が必要だが、PONIファイルが登録されていない状態でも、データの取得や画像の保存は可能である。
  3. Calibrate detector geometry: 先述の通り、2つ以上の異なるカメラ長で取得された標準試料XRDデータをもとに、検出器位置を校正する。なお、本アプリは、検出器そのものの制御機能も備えており、標準試料データの取得も本アプリ内で行える。
  4. Experimental Scheduler: 自動測定シーケンス内で XRD 測定を行う場合には、 pyFAI の校正情報が必要。

参考文献

  • PyFAI, a versatile library for azimuthal regrouping. J. Kieffer and D. Karkoulis. J. Phys.: Conf. Ser., 425 202012 (2013) http://dx.doi.org/10.1088/1742-6596/425/20/202012
  • PyFAI: a Python library for high performance azimuthal integration on GPU. J. Kieffer and J. P. Wright. Powder Diffraction, 28, S2, S339--S350. (2013) http://dx.doi.org/10.1017/S0885715613000924
  • X線回折実験における統合解析支援ソフトウェアの開発. 瀬戸 雄介, 浜根 大輔, 永井 隆哉, 佐多 永吉. 高圧力の科学と技術, 20, 3, 269--276. (2010)

開発関係

オフライン起動

# Simulates the PM16C stage controller — no network connection required
python main.py --debug

ライセンス

GPL-3.0

開発者

  • Hiroki Kobayashi (Geochemical Research Center, Graduate School of Science, The University of Tokyo, Japan), hiroki [at] eqchem.s.u-tokyo.ac.jp

開発に際しては Claude Code の補助を利用しています。

About

Python-based platform for BL-18C, Photon Factory, KEK, Japan

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages