XPS(survey, narrow)[ULVAC-PHI]¶

フォルダに含まれるファイルの説明¶

プログラム名	説明
MPExport.exe	ULVAC-PHI製変換ツール（.spe,.proのファイルからtxtファイルを作成するツール)
txt2csv.py	txtファイルからFND(Formatted Numerical Data)のcsvファイルを作成するツール
csv2graph.py	FND(Formatted Numerical Data)のcsvファイルからスペクトルの図を作成するツール
txt2raw_XPS_survey.py	txtファイルから装置出力パラメータを抽出するツール
xps_raw_templateXML.xml	装置出力パラメータ抽出に使用するテンプレートファイル
raw2primary_XPS_survey.py	装置出力パラメータファイルから主要パラメータを抽出するツール
xps_primary_template.xml	主要パラメータ抽出に使用するテンプレートファイル
batch_exe_XPS.py	speファイルからスペクトルの図作成、装置出力パラメータ、主要パラメータの抽出までを一度に行うツール
README.rst	使い方の説明

Jupyter Notebook での実行¶

Anaconda Prompt を立ち上げ、ダウンロードディレクトリ配下の PHI_XPS_survey_narrow_tools に移動します。

cd [download directory]/PHI_XPS_survey_narrow_tools

Jupyter notebook を立ち上げます。

jupyter notebook

Jupyter notebook から xps_survey.ipynb を利用すると簡単に実行できます。

Jupyter notebook での使い方は XPS for jupyter notebook を参照してください。

コマンド¶

.spe 形式のファイルをテキストファイルに変換します。

MPExport.exe -Filename:"..\source\XPS_PHI_QUANTERA_survey.spe" -TSV

カレントディレクトリに XPS_PHI_QUANTERA_survey.txt を出力します。

Note

MPExport.exe は Windows用実行ファイルです。-Filename: の後に変換元のファイル名を記述します。

カレントディレクトリ以外の場所を指定する場合のパスは Windows の記述形式で指定します。

(例)..￥source￥XPS_PHI_QUANTERA_survey.spe

その他のオプションについては、

MPExport.exe

を単体で実行して参照してください。

Warning

Linuxなどで動作させる場合には、wine などのwindowアプリケーション対応ソフトを使用して動作させてください。

.txt 形式のファイルをフォーマットした数値データ .csv に変換します。

python txt2csv.py "XPS_PHI_QUANTERA_survey.txt"

カレントディレクトリに XPS_PHI_QUANTERA_survey.csv を出力します。

Note

-h オプションをつけて実行すると、ヘルプを表示します。

python txt2csv.py -h

.csv 形式のファイルから画像を作成します。

python csv2graph.py "XPS_PHI_QUANTERA_survey.csv"

カレントディレクトリに XPS_PHI_QUANTERA_survey.png を出力します。

Note

ファイル名に日本語が含まれる場合、対応するフォントが存在しないとエラーとなり画像が作成されない場合があります。

その場合は、csv2graph.py、batch_exe_XPS.py の日本語フォント対応部分を確認してください。

csv2graph.py: 56行目または batch_exe_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_survey_narrow_tools )にコピーします。

cp ipag.ttf [download directory]/PHI_XPS_survey_narrow_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_survey.py "XPS_PHI_QUANTERA_survey.txt" xps_raw_template.xml raw.xml

Note

--stdout のオプションをつけると標準出力にも出力します。

python txt2raw_XPS_survey.py "XPS_PHI_QUANTERA_survey.txt" xps_raw_template.xml raw.xml --stdout

装置出力パラメータファイル raw.xml から主要パラメータを抽出し、 primary.xml に出力します。

python raw2primary_XPS_survey.py raw.xml xps_primary_template.xml primary.xml

バッチ処理¶

上記のコマンドをまとめて実行できると便利です。

batch_exe_XPS.py は、上記のコマンドをまとめて行うプログラムです。

python batch_exe_XPS.py "../source/XPS_PHI_QUANTERA_survey.spe"

を実行すると、 ../result/XPS_PHI_QUANTERA_survey というフォルダを作成し、その中に FND(Formatted Numerical Data)、スペクトルの図、装置出力パラメータ、主要パラメータファイルを出力します。

連続変換を行いたい場合などに使用します。

Descriptions of script files in this folder.¶

Name of program	Description
MPExport.exe	a conversion tool made by ULVAC-PHI( a tool makes a txt file from .spe or .pro files.)
txt2csv.py	a tool that makes a FND(Formatted Numerical Data)csv file from a txt file.
csv2graph.py	a tool to create spectral diagrams from FND (Formatted Numerical Data) csv files
txt2raw_XPS_survey.py	a tool extracts device output parameters from a txt file.
xps_raw_templateXML.xml	a template file used for the extraction of device output parameters.
raw2primary_XPS_survey.py	a tool extracts primary parameters from device output parameters.
xps_primary_template.xml	a template file used for the the extraction of primary parameters.
batch_exe_XPS.py	a tool that extracts from a spe file device output parameters and primary parameters and creates spectral diagrams at the same time.
README.rst	Descriptions of how to use.

Executions using Jupyter Notebook.¶

Launch anaconda prompt window and move to PHI_XPS_sruvey_narrow_tools directory located under the download directory.

cd [download directory]/PHI_XPS_survey_narrow_tools

There, launch Jupyter notebook.

jupyter notebook

You can use xps_survey.ipynb from Jupyter notebook, and it may be easier to handle.

Please refer to XPS for Jupyter notebook for how to use it on Jupyter notebook.

Commands in command-line¶

This command converts a .spe file into a txt file.

MPExport.exe -Filename:"..\source\XPS_PHI_QUANTERA_survey.spe" -TSV

This outputs XPS_PHI_QUANTERA_survey.txt in the current directory.

Note

MPExpport.exe is only for Windows. -Filename is followed by a path name with a file name. This is a source file you want to convert.

If you want to use a file to convert not located in the current directory,you have to specify a path to the directory followed by the file in such a way that Windows understands.

Example ..\source\XPS_PHI_QUANTERA_survey.spe

If you want to see other options, please type the command alone like this.

MPExport.exe

This shows you other options.

Warning

In case you are using Linux operating system, please use a compatibility layer like wine in order to be run on your system.

The next python script txt2csv.py transforms a .txt file into a .csv file where data are numerically formatted.

python txt2csv.py "XPS_PHI_QUANTERA_survey.txt"

This outputs XPS_PHI_QUANTERA_survey.csv file in the current directory.

Note

When this script is executed with -h option, help massages wil be shown.

python txt2csv.py -h

This phython script csv2graph.py creates an image from a .csv file.

python csv2graph.py "XPS_PHI_QUANTERA_survey.csv"

This outputs XPS_PHI_QUANTERA_survey.png in the current directory.

Note

If in the file name there are Japanese characters used, the image might not be created when the correspoinding Japanese fonts are not installed.

In this case you have to check Japanese font used by csv2graph.py and batch_exe_XPS.py .

How to check what kind of font is used is to see at line 56 in csv2graph.py or at line 237 in batch_exe_XPS.py: There, following code is showing the font being used.

fp = FontProperties(fname=r'C:\WINDOWS\Fonts\meiryo.ttc', size=14)

If you don’t have this font, you can use IPA font provided by IPA(INFORMATION-TECHNOLOGY PROMOTION AGENCY,Japan) at this url.

https://ipafont.ipa.go.jp/old/ipafont/download.html

First, you download ipag.ttf IPA gothic TTF file from the above site, unzip ipag.ttf and copy it to an appropriate folder (ex. PHI_XPS_survey_narrow_tools ) like this,

cp ipag.ttf [download directory]/PHI_XPS_survey_narrow_tools

and then you have to set the first argument called fname to ipag.ttf (as fname=r 'ipag.ttf' note: r in front) for FontProperties() function’s arguments. This function is located at line 56 in csv2graph.py and at line 237 in batch_exe_XPS.py .

fp = FontProperties(fname=r"ipag.ttf", size=14)

This python script extracts device output parameters from a .txt file and output a raw.xml file.

python txt2raw_XPS_survey.py "XPS_PHI_QUANTERA_survey.txt" xps_raw_template.xml raw.xml

Note

Using --stdout option at the end of the command-line, this outputs to the standard output also.

python txt2raw_XPS_survey.py "XPS_PHI_QUANTERA_survey.txt" xps_raw_template.xml raw.xml --stdout

This python script extracts primary parameters from a device output parameter file raw.xml and output it to primary.xml file.

python raw2primary_XPS_survey.py raw.xml xps_primary_template.xml primary.xml

Batch processing.¶

It is convenient to be able to run python scripts described above at the same time.

This batch_exe_XPS.py is a program that can execute above scripts at the same time.

python batch_exe_XPS.py "../source/XPS_PHI_QUANTERA_survey.spe"

This script creates ../result/XPS_PHI_QUANTERA_survey folder and then output in there, a FND(Formatted Numerical Data) file, a spectral diagram, a device output parameter file, and a primary parameter file.

This script is suitable when you want to process data in a continuous fashion.