run_winコマンドマニュアル

(The documentation of run_win command)

Last Update: 2023/4/26

◆機能・用途(Purpose)

WINをパラメータファイル無しで起動する。
Start WIN without a parameter file.

WIN形式の地震波形データは東京大学地震研究所の WINシステムを用いて表示できる。しかしそのためには設定ファイルをいくつか用意しなければならず、波形を手早く見たい場合に手間である。設定の多くは連続波形からの地震の検知や震源決定のためのものであり、単に波形を表示するだけであれば不要なはずである。
Seismic waveforms in WIN format can be viewed using the WIN system developed by the Earthquake Research Institute, the University of Tokyo, Japan. However, the WIN system requires several configuration files, which slows down a rapid viewing of the waveforms. Most of the configurations are used for detecting earthquakes from the continuous records and locating the earthquakes; these configurations should not be needed for just looking at the waveforms.

run_winコマンドではダミーのパラメータファイルを自動生成してWINを起動する。これにより、ユーザから見ればパラメータファイルを用意することなく WINの波形データを表示することが可能になる。ダミーのパラメータファイルは一時ファイルとして作成され、ユーザがWINを閉じれば自動的に削除される。
The run_win command automatically creates a dammy parameter file and then starts WIN. By this, users can look at the waveforms in a WIN file without preparing a parameter file. The dammy parameter file is created as a temporary file that will be automatically removed when the user closes WIN.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/win_data/src/run_win.c

◆環境設定(Environmental setting)

run_winコマンドを使用するにはWINシステムをインストールし、そのパス設定をymaeda_opentoolsの環境設定よりも前で行う必要がある。
To use the run_win command, install the WIN system and add its path in advance to the environmental settings of ymaeda_opentools.

WINシステムをインストール済みであるにも関わらず run_winコマンドが動かない場合、 WINシステムのパス設定とymaeda_opentoolsの環境設定の順番をチェックする。下記の例を参照。
If the WIN system was installed in your computer and nevertheless the run_win command does not work, check the order of the path setting for the WIN system and the environmental settings for ymaeda_opentools; see the example below.

~/.bashrcの良い例 (Good example for ~/.bashrc)

export PATH=${PATH}:/usr/local/win/bin
export YMAEDA_OPENTOOL_DIR=/usr/local/ymaeda_opentools
source $YMAEDA_OPENTOOL_DIR/share/initall.bashrc

~/.bashrcの悪い例 (Bad example for ~/.bashrc)

export YMAEDA_OPENTOOL_DIR=/usr/local/ymaeda_opentools
source $YMAEDA_OPENTOOL_DIR/share/initall.bashrc
export PATH=${PATH}:/usr/local/win/bin

◆使用方法(Usage)

コマンドライン引数でパラメータを指定する。パラメータの一覧を下表に示す。
Specify parameters by command-line arguments. The table below shows a list of parameters.

●「-」から始まらない引数 (Arguments not beginning with “-”)

引数 Argument	与える値 Quantity to be given
第1引数 1st argument	開きたいWINデータファイル名。 The name of the WIN data file to open.

●1つの「-」から始まる引数 (Arguments beginning with a single “-”)

このコマンドでは1つの「-」から始まる引数は存在しない。
This command does not have arguments beginning with a single “-”.

●「--パラメータ名=パラメータ値」の形式の引数 (Arguments of a form “--Parameter name=Parameter Value”)

「--パラメータ名=パラメータ値」の形式の引数は自由な順番で指定できる。「-」から始まらない引数の間に挿入しても良い。相反する指定がなされた場合には後の指定が優先される。デフォルト値を持つパラメータは省略できる。
Arguments of a form “--Parameter name=Parameter Value” can be placed in an arbitrary order. They can even be inserted between arguments not beginning with “-”. In case of conflicting options being specified, the latter option has a higher priority. Parameters that have default values can be omitted.

パラメータ名 Parameter name	意味 Meaning	可能なパラメータ値 Allowed parameter values	デフォルト値 Default value
trg_dir	波形データファイル(トリガファイル)のディレクトリ名。 The directory path for waveform data files (trigger files).	ディレクトリ名を表す文字列。 A string that represents a directory name.	"."
channel_table	チャネル表ファイル名。 The channel table file name.	ファイル名を表す文字列。このパラメータを指定した場合はダミーファイルは作成されないので実在するファイルでなければならない。 A string that represents a file name. Make sure that the file is present, as a dammy file is not created when this parameter is specified.	省略時はダミーの一時ファイルが作成・利用される。 When this parameter is omitted, a dammy temporary file is created and used.
zone_file	観測点の地域分け(ゾーン)を記述したファイル名。 The name of a file that defines subregions (zones) of stations.	ファイル名を表す文字列。このパラメータを指定した場合はダミーファイルは作成されないので実在するファイルでなければならない。 A string that represents a file name. Make sure that the file is present, as a dammy file is not created when this parameter is specified.	省略時はダミーの一時ファイルが作成・利用される。 When this parameter is omitted, a dammy temporary file is created and used.
pick_dir	P波・S波の読み取り値と震源決定結果(pickファイル)の保存先ディレクトリ名。 The directory path for the picked P- and S-wave arrival times and hypocenters (pick files).	ディレクトリ名を表す文字列。 A string that represents a directory name.	"."
hypomh_command	震源決定に用いるコマンドのフルパス。 A full path of the command used for hypocenter determination.	ファイル名を表す文字列。 A string that represents a file name.	$WIN_DIR/bin/hypomh
structure_file	震源決定に用いる速度構造ファイル名。 The file for a velocity structure used for the hypocenter determination.	ファイル名を表す文字列。このパラメータを指定した場合はダミーファイルは作成されないので実在するファイルでなければならない。 A string that represents a file name. Make sure that the file is present, as a dammy file is not created when this parameter is specified.	省略時はダミーの一時ファイルが作成・利用される。 When this parameter is omitted, a dammy temporary file is created and used.
map_file	地図データファイル名。 A map data file name.	ファイル名を表す文字列。このパラメータを指定した場合はダミーファイルは作成されないので実在するファイルでなければならない。 A string that represents a file name. Make sure that the file is present, as a dammy file is not created when this parameter is specified.	"none"
output_dir	切り出した波形データの出力先ディレクトリ名。ズーム波形で拡大表示した部分の波形をファイルに切りだして、他のプログラムなどで利用することができる。そのファイルを作るディレクトリを指定する。 The directory path to store trimmed waveforms. Partial waveforms in a zoom view can be extracted as separate files than can be used for other programs. Specify the directory path to these partial waveforms.	ディレクトリ名を表す文字列。 A string that represents a directory name.	"."
output_format	切り出した波形データの出力フォーマット。 The output format of the trimmed waveforms.	C 1行1サンプルの数字によるテキストファイル。 A text file with the numerical value of each sample in each line. B4 バイナリ4バイト整数。 Binary 4-byte integers. B2 バイナリ2バイト整数。 Binary 2-byte integers. A オーディオフォーマット。 An audio format.	C
filter_file	フィルターの設定ファイル名。 A configuration file name for filters.	ファイル名を表す文字列。このパラメータを指定した場合はダミーファイルは作成されないので実在するファイルでなければならない。 A string that represents a file name. Make sure that the file is present, as a dammy file is not created when this parameter is specified.	省略時はダミーの一時ファイルが作成・利用される。 When this parameter is omitted, a dammy temporary file is created and used.
printer	ハードコピー用プリンタ名。 The name of a printer for hard copy.	プリンタ名を表す文字列。 A string that represents a printer name.	&
projection	初動の押し引きの投影方法。 The projection method for the polarity of first motion.	upper 上半球に投影する。 Project on an upper hemisphere. lower 下半球に投影する。 Project on a lower hemisphere.	upper
label_file	震源決定結果に付けるラベルのリストファイル名。 The name of a file that defines the labels appended to the pick results.	ファイル名を表す文字列。このパラメータを指定した場合はダミーファイルは作成されないので実在するファイルでなければならない。 A string that represents a file name. Make sure that the file is present, as a dammy file is not created when this parameter is specified.	省略時はダミーの一時ファイルが作成・利用される。 When this parameter is omitted, a dammy temporary file is created and used.
hypocenter_dir	地図表示のための震源データファイルを探すディレクトリパス。 A directory path to search hypocnter data files for map view.	ディレクトリ名を表す文字列。 A string that represents a directory name.	"."
dpi	地図の縮尺を正しくするためのDPI数。 The number of DPIs to correct a map scale.	正の実数。 A positive real number.	100.0
tmp_dir	一時ファイルの保存先ディレクトリ名。 run_winコマンドから出力される一時ファイルではなく、 WINシステム内で生成される一時ファイルのディレクトリを指定する。 A directory path for temporary files. Not the temporary files created by run_win command but the temporary files created within the WIN system.	ディレクトリ名を表す文字列。 A string that represents a directory name.	/tmp

◆動作(Behaviour)

第1引数で指定したWINデータファイルを winコマンド($WIN_DIR/bin/win)を用いて開く。その際にパラメータファイル(win.prm)が必要になるので一時ファイルとして自動的に作成する。このファイルは16個のパラメータを必要とし、それらは--から始まる16個のパラメータに対応するので、それらの値(省略されたものについてはデフォルト値)を自動的に書き込む。
Open the WIN data file specified by the 1st argument using the win command ($WIN_DIR/bin/win). Automatically creates the parameter file (win.prm) needed by the win command. This parameter file consists of the 16 parameters specified by the options beginning with “--”; for omitted parameters, the default values are used.

パラメータchannel_tableが省略された場合、チャンネルIDを観測点コード、ダミーを表す「dm」を成分コードとするダミーのチャンネルテーブルが自動的に生成される。このダミーのチャンネルテーブルにおいては振幅スケールに関係するパラメータは全て1 (すなわち波形のデジタルカウント値をそのまま速度(m/s)として表示する設定)、観測点位置は北緯35°、東経137°、標高0mとなる。当然ながらこの場合には震源決定を行うことはできない。
When the parameter channel_table is omitted, a dammy channel table is automatically created, in which the station codes are equal to the channel IDs and the component codes are “dm” (which means “dammy”). This dammy channel table gives 1 for all scale factors (i.e., the digital count values are displayed as velocities (m/s)), and the stations are located at 35°N, 137°E, and an altitude of 0 m. It is obvious that the hypocenter determination is impossible in this case.

パラメータzone_fileが省略された場合、 ALLという名前の1つの地域に全観測点を入れた一時ファイルが自動的に生成される。
When the parameter zone_file is omitted, a temporary file is automatically created, in which all stations are in a single zone with a name “ALL”.

パラメータstructure_file, filter_file, label_fileが省略された場合、対応するファイルが一時ファイルとして自動的に生成される。その中身は WINシステムの公式マニュアル(2023/3/23時点)において例示されているものとなる。
When the parameters structure_file, filter_file, or label_file are omitted, the corresponding temporary files are automatically created. The file is equivalent to the example shown in the official documentation of the WIN system (accessed on March 23, 2023).

これらの一時ファイルはWINを終了すると自動的に消去される。
These temporary files are automatically removed when the WIN display is closed.

◆使用例(Example)

run_win --trg_dir=./trg --pick_dir=./picks --channel_table=./channels.tbl

run_winコマンド マニュアル