PythonとIgorの連携

高エネルギー加速器研究機構物質構造科学研究所量子ビーム連携研究センター山田悟史

pyigorの活用

pyigorライブラリーを使うとPythonとIgorの間でデータだけでなくコマンドの連携も可能になります。
- ただし、Igor 7.0以降が必要
- あと、バグ（？）を含めて少しコードの書き換えが必要

セットアップ

Igorの準備（HDF5 XOPとPyIgor用スクリプトのインストール）
- HDF5のセットアップ（Igor 9以降は不要）
  - Igorのインストール先フォルダーを開く
    - Igorのメニューから以下をたどるとフォルダが開く（英語版の場合）
      - Help > Show Igor Pro Folder
    - うまくいかない時は自分で探す。
      - Win10のIgor8の場合は以下の通り（デフォルトの場合）
        
        C:\Program Files\WaveMetrics\Igor Pro 8 Folder
    - 上記のフォルダから以下の階層に進み、”HDF5-64.xop”をコピーする
      - More Extensions (64-bit) > File Loaders
  - Igorのユーザーライブラリーを開く
    - Igorのメニューから以下をたどるとフォルダが開く（英語版の場合）
      - Help > Show Igor Pro User Files
    - これもうまく行かないときは自分で探す。
      - Win10のIgor8の場合は以下の通り
        
        C:\Users\（ユーザー名）\Documents\WaveMetrics\Igor Pro 8 User Files
    - 上記のフォルダから以下の階層に進み、先ほどコピーした”HDF5-64.xop”を貼り付ける
      - Igor Extensions (64-bit)
      - 上記xopファイルのショートカットを作って貼り付けるでも多分OK
- pyigorのgithubからIgor用のスクリプトpyigor.ipfをダウンロードし、以下のフォルダにコピーする
  - Igor Procedures
pyIgorの準備
- Pythonのコマンドラインから以下のコマンドを実行し、ライブラリーをインストール
```
pip install pyigor
```
- ver. 0.1.6だとwindowsでは動かなかったため以下のファイルを編集する必要があったが、バグ報告したらver. 0.2.0で（少なくとも私の環境では）動くようになったので、おそらく以下のハイライト部分は実施不要（だが、念のため記録として残しておく）
  - C:\Users\（ユーザー名）\miniconda3\envs\（環境名）\Lib\site-packages\pyigor\pyigor.py
    - 以下に示す修正はとりあえず動くようにした、という感じなので、実装としてあまり美しくない気がするが、とりあえず目をつぶる
    - 170行目の修正はMacでも必要かもしれない
      - （参考）修正後のファイルはこちら
        
        pyigor.py
  - 16行目を以下の通り修正
    - Igorの実行ファイルの場所がMac仕様になっているのでWin仕様に変更する
      - 下記はWin10のIgor8の場合なので、自身の環境に合わせて場所を指定する
```
#path_candidates = glob.glob("/Applications/Igor Pro*/Igor64.app/Contents/MacOS/Igor64")
path_candidates = glob.glob("C:\\Program Files\\WaveMetrics\\Igor Pro 8 Folder\\IgorBinaries_x64\\Igor64.exe")
```
  - 160行目を以下の通り修正
    - ここでは、OSのシェルからIgorのコマンドラインを叩いている
      - -XオプションがIgorのコマンドラインを実行
      - -QオプションがIgorの履歴への反映を抑制
    - Windowsの場合、コマンドラインを実行するクラスsubprocess.run()の引数にシーケンスを入れると、シーケンス中のダブルクォーテーションを勝手に ” から \” に変換してしまう。
      - で、Igorはそんなこと要求してないのでエラーを吐く
      - subprocess.run()の引数を文字列にすると、この余計なお世話が回避できるので、一度文字列に変換してからsubprocess.run()を実行する
```
#subprocess.run([self._executable_path, "-Q", "-X", command])
temp = subprocess.list2cmdline([self._executable_path, "-Q", "-X"])
temp = f"{temp} {command}"
subprocess.run(temp)
```
  - 170行目を以下の通り修正（Macも？）
    - 代入演算子(=)が比較演算子(==)になってるように見える
      - 一応、以下の通り変更すると動くことを確認
```
#self._registered_functions[f.__name__] == f
self._registered_functions[f.__name__] = f
```

使い方（pyigorのインストラクションと同じ）

PythonからIgorへのアクセス
- ライブラリーのインポートとIgorとの接続
  - Connection() を呼び出す
```
from pyigor import Connection
import numpy as np

igor = Connection()
```
- 配列を作ってIgor上にwaveを渡す
  - ここでは”sinwave”という名前で正弦波を保存
  - HDF5というフォーマットでファイルを保存し、Igorで読ませてる模様
```
### Sending an array to Igor Pro
array = np.sin(np.linspace(0, 10, 100))
igor.put(array, "sinwave")
```
- Igorのコマンドラインを実行することも可能
  - ここではIgor上で先ほどのsinwaveに1を加える処理を実行
```
### Executing a command in Igor Pro
igor("sinwave += 1")
```
- Igor上で変更したデータsinwaveをPythonにコピー
  - ここでもHDF5というフォーマットでデータをやりとりしている模様
```
### Getting a wave from Igor Pro
wv = igor.get("sinwave")
print(wv.array)
```
IgorからPythonへのアクセス
- 上記と同じ手順でConnection()した後、以下の要領でIgorから使いたい関数を定義する
  - “@igor.function”がIgorから叩けるようにするためのデコレーター
    - http://127.0.0.1:15556/call/<command> で以下の通りに定義した関数を呼び出せるようになる
      - なので、Igorを使わずにコマンドプロンプトでcurlを使っても叩ける
    - これが通らない時（self._registered_functions[f.name] == f でエラーが出る）は前述の「pyIgorの準備」で述べた通りにこの行を修正する
```
### @igor.function decorator makes the function callable from Igor Pro.
@igor.function 
def myfunc(a):
	return a*a
```
- Igorからは PyIgorCall(<command>) でPythonの関数を呼び出せる
  - 例えばIgorのコマンドラインで以下のようにアクセスすると 100 が返ってくる
```
PyIgorCall("myfunc(10)")
```
  - コマンドプロンプトだと以下の通り（あまり意味は無いが）
```
curl <http://127.0.0.1:15556/call/myfunc(10)>
```