summarize_win_hypoコマンド マニュアル

(The documentation of summarize_win_hypo command)
Last Update: 2023/4/6

◆機能・用途(Purpose)

WINで求めた震源を1つのテキストファイルにまとめる。
Gather the hypocenters determined by WIN to a single text file.
WINの震源決定結果は パラメータファイル(win.prmなど)の4行目で指定したディレクトリ(picksなど) の下に1つの地震につき1ファイルで記録される。 これらのファイルはpickファイルと呼ばれる。 pickファイルは地震の数だけ存在し、 発震時刻の秒の部分が負の値になっているケースもあるため、 それらのファイルから情報を集めて 震源分布図の作成など地震活動の全体像の把握に活用するには一手間かかる。 summarize_win_hypoコマンドを用いるとこの処理を簡単に行うことができる。 このコマンドでは 指定したディレクトリ内にあるpickファイルを全て読み込んで震源情報をまとめ、 1つのテキストファイルに出力する。
The results of locating earthquakes by WIN are recorded beneath a directory (e.g., picks) specified by the 4th line of a parameter file (e.g., win.prm). Information on each earthquake is recorded in each file that is usually called a pick file. Abundant pick files and occasional negative values for the second of the origin time require some works for gethering the information from the pick files and understanding the characteristics of the entire seismicity (e.g., creating a hypocenter map). The summarize_win_hypo command easens this processing; it reads all pick files in a specified directory and summarizes the hypocenter information into a single text file.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/win_data/src/summarize_win_hypo.c


◆使用方法(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 		pickファイルが保存されているディレクトリパス。
The directory path of the pick files.
第2引数
2nd argument 		出力ファイル名。
The output file name.


●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
pickfile_location ピックファイルの場所。
Locations of pick files.
  • direct
    第1引数で指定したディレクトリの下に直接置かれている。
    The pick files are located directly beneath the directory specified by the 1st argument.

  • YYMM
    第1引数で指定したディレクトリの下に年・月ごとのサブディレクトリがあり、 その下に置かれている。 サブディレクトリ名はYYMMである。 但しYYは年の下2桁、MMは月(2桁)。
    The pick files are located beneath subdirectories based on years and months under the directory specified by the 1st argument. The subdirectory names are YYMM, where YY is the lowest 2-digits of the year and MM is the month (2-digits).

 YYMM
start 処理対象とする日時範囲の先頭。
The beginning of the date-time range to process. 		YYYY/MM/DD_hh:mm:ss.sssの形式の文字列。 ここで
  • YYYY : 年(4桁)
  • MM : 月(2桁)
  • DD : 日(2桁)
  • hh : 時(2桁)
  • mm : 分(2桁)
  • ss.sss : 秒(整数部2桁、小数点以下3桁)
である。
A string of a form YYYY/MM/DD_hh:mm:ss.sss, where
  • YYYY is the year (4-digits),
  • MM is the month (2-digits),
  • DD is the day (2-digits),
  • hh is the hour (2-digits),
  • mm is the minute (2-digits), and
  • ss.sss is the second (2-digits in the integer part and 3-digits in the decimal part).
 省略時は先頭日時の制限なしとなる。
When this parameter is omitted, there is no restriction for the beginning date and time.
end 処理対象とする日時範囲の末尾。
The end of the date-time range to process. 		YYYY/MM/DD_hh:mm:ss.sssの形式の文字列。 ここで
  • YYYY : 年(4桁)
  • MM : 月(2桁)
  • DD : 日(2桁)
  • hh : 時(2桁)
  • mm : 分(2桁)
  • ss.sss : 秒(整数部2桁、小数点以下3桁)
である。
A string of a form YYYY/MM/DD_hh:mm:ss.sss, where
  • YYYY is the year (4-digits),
  • MM is the month (2-digits),
  • DD is the day (2-digits),
  • hh is the hour (2-digits),
  • mm is the minute (2-digits), and
  • ss.sss is the second (2-digits in the integer part and 3-digits in the decimal part).
 省略時は末尾日時の制限なしとなる。
When this parameter is omitted, there is no restriction for the end date and time.
exclude_pickers 出力に含めない検測者名のリスト。 検測者名がこのリストのいずれかに該当する地震は出力しない。
List of pickers excluded from the output. Earthquakes picked by one of these pickers are excluded from the output. 		検測者名をカンマ(,)で区切って並べた文字列。
A string composed of the picker names separated by commas (,). 		省略時は検測者名による除外を行わない。
When this option is omitted, the hypocenters are not excluded based on the picker names.
exclude_labels 出力に含めないラベルのリスト。 ラベルがこのリストのいずれかに該当する地震は出力しない。
List of labels excluded from the output. Earthquakes with one of these labels are excluded from the output. 		ラベル名をカンマ(,)で区切って並べた文字列。
A string composed of the label names separated by commas (,). 		省略時はラベルによる除外を行わない。
When this option is omitted, the hypocenters are not excluded based on the labels.
required_stations_or 読み取り値に含まれなければならない観測点コードのリスト。 この引数で指定した観測点のいずれも読み取り値に含まれない地震は 出力をスキップする。
List of station codes that have to be included in the pick data. Earthquakes are skipped from the output if none of these stations have the pick data. 		観測点コードをカンマ(,)で区切って並べた文字列。
A string composed of the station codes separated by commas (,). 		省略時は読み取りデータに含まれる観測点のチェックを行わない。
When this option is omitted, the stations included in the pick data are not checked.


◆動作(Behaviour)

第1引数とパラメータpickfile_locationで指定されるディレクトリの下の 全てのpickファイルを読み込み、 第2引数で指定したファイルに震源情報を出力する。 出力は1行につき1つの地震の情報とし、以下の情報が出力される。 列の区切りにはタブが用いられる。
Read all pick files beneath the directories specified by the 1st argument and parameter pickfile_location and output the hypocenter information to the file specified by the 2nd argument. Each line of the output consists of the information on each earthquake. The contents of each line is as below. Tabs are used to separate the columns.
列
Column 		値
Value
1 発震日時(YYYY/MM/DD hh:mm:ss.sssフォーマット)。 ここで
  • YYYY : 年(4桁)
  • MM : 月(2桁)
  • DD : 日(2桁)
  • hh : 時(2桁)
  • mm : 分(2桁)
  • ss.sss : 秒(整数部2桁、小数点以下3桁)
である。
The origin time of an earthquake in YYYY/MM/DD hh:mm:ss.sss format, where
  • YYYY is the year (4-digits),
  • MM is the month (2-digits),
  • DD is the day (2-digits),
  • hh is the hour (2-digits),
  • mm is the minute (2-digits), and
  • ss.sss is the second (2-digits in the integer part and 3-digits in the decimal part).
2 震源の緯度(°)。桁数はpickファイルのままとする。
The latitude (°) of the hypocenter, with the same number of digits as that in the pick file.
3 震源の経度(°)。桁数はpickファイルのままとする。
The longitude (°) of the hypocenter, with the same number of digits as that in the pick file.
4 震源の深さ(km)。 海水準を0(海水準よりも上の場合は負の値)とする。 桁数はpickファイルのままとする。
The depth (km) of the hypocenter measured from the sea level (a negative value if the hypocenter is above sea level), with the same number of digits as that in the pick file.
5 地震のマグニチュード。 桁数はpickファイルのままとする。 マグニチュードが求まっていない地震の場合は9.9となる。
The magnitude of the earthquake, with the same number of digits as that in the pick file. A value of 9.9 means that the magnitude of the earthquake is not determined.
6 検測者名。
The picker name.
7 地震に付けられたラベル。
The label appended to the earthquake.
8 pickファイル名(パス無し)。
The pick file name with no path.
9 読み取りに使用した波形ファイル(trgファイル)名(パス無し)。
The name of the waveform file used (called a trg file) with no path.


◆使用例(Example)

summarize_win_hypo /dat/picks/man hypo2022.txt --start=2022/01/01_00:00:00.000 --end=2022/12/31_23:59:59.999 --exclude_pickers=auto --exclude_labels=FAR,NOISE


◆追記事項(Additional notes)

pickファイルはWINによって作成されたファイル あるいはそれと同じフォーマットでなければならない。 具体的には以下の要件が満たされなければならない。
The pick files must be created by WIN, or must have the same format as those created by WIN. Below are the requirements for the pick files.