XPS(depth)[ULVAC-PHI]¶
フォルダに含まれるファイルの説明¶
プログラム名 |
説明 |
|---|---|
MPExport.exe |
ULVAC-PHI製変換ツール（.spe,.proのファイルからtxtファイルを作成するツール) |
txt2csv_depth.py |
txtファイルからFND(Formatted Numerical Data)のcsvファイルを作成するツール |
csv2graph_depth.py |
FND(Formatted Numerical Data)のcsvファイルからスペクトルの図を作成するツール |
txt2raw_XPS_depth.py |
txtファイルから装置出力パラメータを抽出するツール |
xps_raw_depth_template.xml |
装置出力パラメータ抽出に使用するテンプレートファイル |
raw2primary_XPS_depth.py |
装置出力パラメータファイルから主要パラメータを抽出するツール |
xps_primary_depth_template.xml |
主要パラメータ抽出に使用するテンプレートファイル |
batch_exe_depth_XPS.py |
speファイルからスペクトルの図作成、装置出力パラメータ、主要パラメータの抽出までを一度に行うツール |
README.rst |
使い方の説明 |
Jupyter Notebook での実行¶
Anaconda Prompt を立ち上げ、ダウンロードディレクトリ配下の PHI_XPS_depth_tools に移動します。
cd [download directory]/PHI_XPS_depth_tools
Jupyter notebook を立ち上げます。
jupyter notebook
Jupyter notebook から xps_depth.ipynb を利用すると簡単に実行できます。
Jupyter notebook での使い方は XPS(depth) for jupyter notebook を参照してください。
コマンド¶
.pro 形式のファイルをテキストファイルに変換します。
MPExport.exe -ExportProfile -Filename:"..\source\XPS_PHI_QUANTERA_depth_1.pro"
カレントディレクトリに XPS_PHI_QUANTERA_depth_1.txt を出力します。
Note
MPExport.exe は Windows用実行ファイルです。-Filename: の後に変換元のファイル名を記述します。
カレントディレクトリ以外の場所を指定する場合のパスは Windows の記述形式で指定します。
(例)..￥source￥XPS_PHI_QUANTERA_depth_1.pro
その他のオプションについては、
MPExport.exe
を単体で実行して参照してください。
Warning
Linuxなどで動作させる場合には、wine などのwindowアプリケーション対応ソフトを使用して動作させてください。
.txt 形式のファイルをフォーマットした数値データ .csv に変換します。
python txt2csv_depth.py "XPS_PHI_QUANTERA_depth_1.txt"
カレントディレクトリに XPS_PHI_QUANTERA_depth_1.csv を出力します。
Note
-h オプションをつけて実行すると、ヘルプを表示します。
python txt2csv_depth.py -h
.csv 形式のファイルから画像を作成します。
python csv2graph_depth.py "XPS_PHI_QUANTERA_depth_1.csv"
カレントディレクトリに XPS_PHI_QUANTERA_depth_1.png を出力します。
Note
ファイル名に日本語が含まれる場合、対応するフォントが存在しないとエラーとなり画像が作成されない場合があります。
その場合は、csv2graph_depth.py、batch_exe_depth_XPS.py の日本語フォント対応部分を確認してください。
csv2graph_depth.py: 56行目 または batch_exe_depth_XPS.py: 237行目
fp = FontProperties(fname=r'C:\WINDOWS\Fonts\meiryo.ttc', size=14)
フォントがない場合には、独立行政法人 情報処理推進機構が提供しているIPAフォントなどを利用することができます。
https://ipafont.ipa.go.jp/old/ipafont/download.html.
上記サイトからTTFファイルのIPAゴシックをダウンロードし、解凍した ipag.ttf を適当なフォルダ(ex. PHI_XPS_depth_tools )にコピーして
cp ipag.ttf [download directory]/PHI_XPS_depth_tools
FontProperties のfnameに指定します。csv2graph.py: 56行目 または batch_exe_XPS.py: 237行目
fp = FontProperties(fname=r'ipag.ttf', size=14)
.txt 形式のファイルから装置出力パラメータを抽出し、 raw.xml を出力します。
python txt2raw_XPS_depth.py "XPS_PHI_QUANTERA_depth_1.txt" xps_raw_depth_template.xml raw.xml
Note
--stdout のオプションをつけると標準出力にも出力します。
python txt2raw_XPS_depth.py "XPS_PHI_QUANTERA_depth_1.txt" xps_raw_depth_template.xml raw.xml --stdout
装置出力パラメータファイル raw.xml から主要パラメータを抽出し、 primary.xml に出力します。
python raw2primary_XPS_depth.py raw.xml xps_primary_depth_template.xml primary.xml
バッチ処理¶
上記のコマンドをまとめて実行できると便利です。
batch_exe_depth_XPS.py は、上記のコマンドをまとめて行うプログラムです。
python batch_exe_depth_XPS.py "../source/XPS_PHI_QUANTERA_depth_1.pro"
を実行すると、 ../result/XPS_PHI_QUANTERA_depth_1 というフォルダを作成し、その中にFND(Formatted Numerical Data)、スペクトルの図、装置出力パラメータ、主要パラメータファイルを出力します。
連続変換を行いたい場合などに使用します。
Descriptions of scripts and template files in this folder.¶
Program name |
Description |
|---|---|
MPExport.exe |
a conversion tool made by ULVAC-PHI(creats a txt file from .spe or .pro files.) |
txt2csv_depth.py |
a tool creates a FND(Formatted Numerical Data) .csv file from a txt file. |
csv2graph_depth.py |
a tool that creates a spectral diagram from a FND(Formatted Numerical Data) .csv file. |
txt2raw_XPS_depth.py |
a tool that extracts device output parameters from a txt file. |
xps_raw_depth_template.xml |
a template file used for extracting device output parameters. |
raw2primary_XPS_depth.py |
a tool that extracts primary parameters from a device output parameter file. |
xps_primary_depth_template.xml |
a template file used for extracting primary parameters. |
batch_exe_depth_XPS.py |
a tool that extracts device output parameters and primary parameters and creates a spectral diagram from a spe file at once. |
README.rst |
description of how to use. |
Execute scripts by using Jupyter Notebook.¶
Launch anaconda prompt window, then move to PHI_XPS_depth_tools directory located under the download directory. You can do this with cd command.
cd [download directory]/PHI_XPS_depth_tools
There, launch Jupyter notebook.
jupyter notebook
Then you use xps_depth.ipynb from Jupyter notebook to launch. This can be applied for various scripts above. It may be easier to run in this way.
Please refer to XPS(depth) for Jupyter Notebook for how to use on Jupyter notebook.
Write Commands in command-line.¶
This MPExport.ext file converts a .pro file to a text file.
MPExport.exe -ExportProfile -Filename:"..\source\XPS_PHI_QUANTERA_depth_1.pro"
This outputs XPS_PHI_QUANTERA_depth_1.txt file in the current directory.
Note
The MPExport.exe file is an executable file for Windows. Please type -Filename: followed by a path to the source file to convert.
In case you want to specify the directroy of the source file to convert other than the current directory, you have to specify the path to the directory in such a way that Windows understands. The directory separator must be appropriately chosen.
Example..\source\XPS_PHI_QUANTERA_depth_1.pro
For other options, you run the command by itself without any arguments.
MPExport.exe
This shows other options for MPExport.exe .
Warning
If you are using Linux operating system, you have to use a compatibility layer like wine to run this executable file.
This python script converts a .txt file to a .csv file in which data are numecially fomatted.
python txt2csv_depth.py "XPS_PHI_QUANTERA_depth_1.txt"
This outputs XPS_PHI_QUANTERA_depth_1.csv file in the current directory.
Note
If you add -h option at the end of the command-line, this shows help messages.
python txt2csv_depth.py -h
This script creates an image from a .csv file,
python csv2graph_depth.py "XPS_PHI_QUANTERA_depth_1.csv"
and outputs XPS_PHI_QUANTERA_depth_1.png in the current directory.
Note
In case there are Japanese charactres used in a file name, you may not be able to get an image if there is no correspinding font installed in the system.
In this case, you have to see what kind of Japanese font is used by checking particular portions of codes in csv2graph_depth.py ,and batch_exe_depth_XPS.py .
They are at line 56 in csv2graph_depth.py and at line 237 in batch_exe_depth_XPS.py . The common expression is looked like,
fp = FontProperties(fname=r'C:\WINDOWS\Fonts\meiryo.ttc', size=14)
If this font is not installed, you can download and use IPA font provided by Information-technology Promotion Agency, Japan, located at,
https://ipafont.ipa.go.jp/old/ipafont/download.html.
From above site, you can downlad IPA Gothic in TTF file, unzip it to get a ipag.ttf file, and then copy and past it into an appropriate folder(ex. PHI_XPS_depth_tools ).
cp ipag.ttf [download directory]/PHI_XPS_depth_tools
Then finally, you specify it as the first argument(as fname=r’ipag.ttp’ note: r in front) for FontProperties() function, located at line 56 of csv2graph.py or at line 237 of batch_exe_XPS.py .
fp = FontProperties(fname=r'ipag.ttf', size=14)
This python script extracts device output paramters from a .txt file and outputs a raw.xml file.
python txt2raw_XPS_depth.py "XPS_PHI_QUANTERA_depth_1.txt" xps_raw_depth_template.xml raw.xml
Note
If you add --stdout option at the end of command-line, this outputs to the standard output also.
python txt2raw_XPS_depth.py "XPS_PHI_QUANTERA_depth_1.txt" xps_raw_depth_template.xml raw.xml --stdout
This script extracts primary paramters from a device output parameter file raw.xml and outputs to primary.xml file.
python raw2primary_XPS_depth.py raw.xml xps_primary_depth_template.xml primary.xml
Batch processing.¶
It is convenient to process above commands altogether at the same time.
batch_exe_depth_XPS.py is a program that can process all of above scripts at the same time.
python batch_exe_depth_XPS.py "../source/XPS_PHI_QUANTERA_depth_1.pro"
If this script is executed, this makes a ../result/XPS_PHI_QUANTERA_depth_1 folder and outputs into this folder, a FND(Formatted Numerical Data) file, a spectral diagram file, a device output paramter file, and a primarly paramter file.
This is used for conversion processing in a continuous fashion.