detect_inflation_continuousコマンド マニュアル

(The documentation of detect_inflation_continuous command)
Last Update: 2024/7/26

◆機能・用途(Purpose)

複数ファイルに分割されたSeismic Analysis Code (SAC)形式の時系列データを 1つの連続する時系列データと見なし、 その中に含まれる火山の山体膨張・収縮に伴う一方向への傾斜変動や変位を Maeda (2023)のアルゴリズムにより検知する。
Detect one-sided tilt changes or displacements in a continuous time series data, that is separated into multiple files of Seismic Analysis Code (SAC) format, caused by inflation or deflation of a volcano edifice using the algorithm proposed by Maeda (2023).

◆概要(Overview)

長期間の連続地震波形は通常、 1時間あるいは1日などの時間単位で区切って別々のファイルに格納される。 このプログラムではこのように複数のファイルに分割された波形データを 連続する1つの時系列データと見なして detect_inflationコマンド と同様の処理を行う。
A long continuous seismic waveform is usually stored in multiple files, divided based on time sections of, for example, 1-hour or 1-day long. This program treats such waveform data, divided into multiple files, as a continuous time series data and performs the same processings as those of detect_inflation command.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/event_detection/src/detect_inflation_continuous.c


◆使用方法(Usage)

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

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

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

●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
inputfiles 入力として用いる波形データファイル名。 ファイルはSAC形式の時系列データファイルとする。 通常、複数のファイルであるが、 それらを列挙するのではなく、 日時をパターンとして含む形で命名規則で与える。
The name of the waveform data files used as the inputs. Each file must be a time series data file of SAC format. Although multiple files are usually used, do not list them but instead give the naming rule of the file names that includes the patterns corresponding to the date and time. 		ファイル名を表す文字列。ディレクトリパスを含んでいても良い。 以下のパターン文字列を含めることができる。
A string that represents a file name, possibly including the directory path. The patterns listed below can be used.
  • %YYYY
    年(西暦、4桁)
    Year (A.D., 4-digits)

  • %YY
    年(西暦、下2桁)
    Year (A.D., lowest 2-digits)

  • %MM
    月(2桁)
    Month (2-digits)

  • %DD
    日(2桁)
    Day (2-digits)

  • %hh
    時(2桁)
    Hour (2-digits)

  • %mm
    分(2桁)
    Minute (2-digits)

  • %ss
    秒(2桁)
    Second (2-digits)

 省略不可
Cannot be omitted
outputfiles_U \(U(t^{st},t^{en})\)のデータの出力先ファイル名。 \(t^{en}\)の値を行番号に、\(t^{en}-t^{st}\)の値を列番号に対応させた 行列形式で出力する。 入力ファイルと同じ時間区切りが用いられるので通常は複数のファイルになるが、 それらを列挙するのではなく、 日時をパターンとして含む形で命名規則で与える。
The names of output files for data of \(U(t^{st},t^{en})\), written as matrices, where the rows and columns correspond to \(t^{en}\) and \(t^{en}-t^{st}\), respectively. Although multiple files are usually created, with the same time sections as the input files, do not list them but instead give the naming rule of the file names that includes the patterns corresponding to the date and time. 		ファイル名を表す文字列。ディレクトリパスを含んでいても良い。 パラメータinputfilesと同様のパターン文字列を含めることができる。 拡張子はymaeda_opentoolsの行列ファイル形式 (独自のファイル形式参照) のいずれかでなければならない。
A string that represents a file name, possibly including the directory path. The patterns same as those for parameter inputfiles can be used. The extension must be that for one of the matrix file formats of ymaeda_opentools (see Special file formats). 		省略時はファイルが出力されない。
The file is not created if this parameter is omitted
outputfiles_M \(M(t^{st},t^{en})\)のデータの出力先ファイル名。 \(t^{en}\)の値を行番号に、\(t^{en}-t^{st}\)の値を列番号に対応させた 行列形式で出力する。 入力ファイルと同じ時間区切りが用いられるので通常は複数のファイルになるが、 それらを列挙するのではなく、 日時をパターンとして含む形で命名規則で与える。
The names of output files for data of \(M(t^{st},t^{en})\), written as matrices, where the rows and columns correspond to \(t^{en}\) and \(t^{en}-t^{st}\), respectively. Although multiple files are usually created, with the same time sections as the input files, do not list them but instead give the naming rule of the file names that includes the patterns corresponding to the date and time. 		ファイル名を表す文字列。ディレクトリパスを含んでいても良い。 パラメータinputfilesと同様のパターン文字列を含めることができる。 拡張子はymaeda_opentoolsの行列ファイル形式 (独自のファイル形式参照) のいずれかでなければならない。
A string that represents a file name, possibly including the directory path. The patterns same as those for parameter inputfiles can be used. The extension must be that for one of the matrix file formats of ymaeda_opentools (see Special file formats). 		省略時はファイルが出力されない。
The file is not created if this parameter is omitted
outputfiles_matrix_info 上記の行列の行番号・列番号と時刻の関係を記したテキストファイル名。 入力ファイルと同じ時間区切りが用いられるので通常は複数のファイルになるが、 それらを列挙するのではなく、 日時をパターンとして含む形で命名規則で与える。
The names of output text files that records the relation between row and column indices and absolute time in the matrices above. Although multiple files are usually created, with the same time sections as the input files, do not list them but instead give the naming rule of the file names that includes the patterns corresponding to the date and time. 		ファイル名を表す文字列。ディレクトリパスを含んでいても良い。 パラメータinputfilesと同様のパターン文字列を含めることができる。 拡張子は何でも良い。
A string that represents a file name, possibly including the directory path. The patterns same as those for parameter inputfiles can be used. The extension is arbitrary. 		省略時はファイルが出力されない。
The file is not created if this parameter is omitted
outputfiles_text 結果の出力先のテキストファイル名。 入力ファイルと同じ時間区切りが用いられるので通常は複数のファイルになるが、 それらを列挙するのではなく、 日時をパターンとして含む形で命名規則で与える。
The names of output text files that records the results. Although multiple files are usually created, with the same time sections as the input files, do not list them but instead give the naming rule of the file names that includes the patterns corresponding to the date and time. 		ファイル名を表す文字列。ディレクトリパスを含んでいても良い。 パラメータinputfilesと同様のパターン文字列を含めることができる。 拡張子は何でも良い。
A string that represents a file name, possibly including the directory path. The patterns same as those for parameter inputfiles can be used. The extension is arbitrary. 		省略時はファイルが出力されない。
The file is not created if this parameter is omitted
start 解析期間の先頭日時。
The beginning date and time of the analysis period. 		「YYYY-MM-DD.hh-mm-ss」の形式の文字列。ここで
  • YYYY: 年(西暦4桁)
  • MM: 月(2桁)
  • DD: 日(2桁)
  • hh: 時(2桁)
  • mm: 分(2桁)
  • ss: 秒(2桁)
である。
A string of “YYYY-MM-DD.hh-mm-ss” format, where
  • YYYY is the year (A.D., 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 is the second (2-digits).
 省略不可
Cannot be omitted
end 解析期間の末尾日時。
The end date and time of the analysis period. 		「YYYY-MM-DD.hh-mm-ss」の形式の文字列。ここで
  • YYYY: 年(西暦4桁)
  • MM: 月(2桁)
  • DD: 日(2桁)
  • hh: 時(2桁)
  • mm: 分(2桁)
  • ss: 秒(2桁)
である。
A string of “YYYY-MM-DD.hh-mm-ss” format, where
  • YYYY is the year (A.D., 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 is the second (2-digits).
 省略不可
Cannot be omitted
file_interval 入力ファイルの時間区切りの長さ(s)。 例えば1時間毎に分割されたファイルを用いる場合は3600となる。
The time length (s) of individual input files. For example, the value is 3600 if the files are divided every 1 hour. 		正の整数。
A positive integer. 		パラメータinputfileに登場するパターン文字列の最小時間単位。 例えばパラメータinputfileに%hhまで登場するなら1時間刻み(3600)、 %mmまで登場するなら1分刻み(60)となる。
The minimum time unit of the pattern strings that appear in parameter inputfile. For example, if the parameter inputfile includes down to %hh then the interval is 1 hour (3600); if %mm is included then 1 min (60).
sminmax_window_length \(s_{min}\), \(s_{max}\)の計算に用いる時間窓の長さ(s)。
The window length (s) for the calculation of \(s_{min}\) and \(s_{max}\). 		パラメータfile_intervalの値以下の実数。
A real number less than or equal to the value of parameter file_interval. 		パラメータfile_intervalの値。
The value of parameter file_interval.
max_window_length 検知に使用する時間窓の長さの上限(s)。
The upper limit (s) of the time window length for detection. 		パラメータsminmax_window_lengthの値以下の正の実数。
A positive real number less than or equal to the value of parameter sminmax_window_length. 		パラメータsminmax_window_lengthの値の1/2倍。
Half of the value of parameter sminmax_window_length.
verbose 進行状況の表示レベル。
Level of displaying the progress.
  • 0 進行状況を表示しない。
    Do not display the progress.

  • 1 1つのファイルの処理が終わるたびに進行状況を表示する。
    Display the progress whenever the processings for each file are complete.

  • 2 1つの\(t^{en}\), 全ての\(t^{st}\)についての処理が終わるたびに 進行状況を表示する。
    Display the progress whenever the processings for each \(t^{en}\) and for all \(t^{st}\) are complete.

  • 3 個々の時間窓\([t^{st},t^{en}]\)に対する処理が終わるたびに 進行状況を表示する。
    Display the progress whenever the processings for each time window \([t^{st},t^{en}]\) are complete.

 3


◆動作(Behaviour)

パラメータstartで指定した日時からendで指定した日時までの期間における、 パラメータfile_intervalで指定した時間間隔で区切られたSAC形式の時系列データファイル (パラメータinputfilesで指定したファイル名パターンを持つもの)を順次読み込み、 これらを連続した1つの時系列データと見なして パラメータmax_window_lengthで指定した長さ以下の全ての時間窓\([t^{st},t^{en}]\)について \(U(t^{st},t^{en})\)と\(M(t^{st},t^{en})\) ( detect_inflationコマンドのマニュアル参照) を計算する。 \(s_{min}\), \(s_{max}\)の計算には パラメータsminmax_window_lengthで指定した長さでかつ \(t^{en}\)を末尾とする時間窓を用いる。 結果はパラメータoutputfiles_U, outputfiles_M, outputfiles_text で指定したファイルに以下のフォーマットで出力する。
Read the time series data files of SAC format (with a pattern of file names specified by parameter inputfiles) from the date and time specified by parameter start to those specified by parameter end at a time interval given by parameter file_interval. Regard them as a continuoues time series data and compute \(U(t^{st},t^{en})\) and \(M(t^{st},t^{en})\) (see the documentation of detect_inflation command) for all combinations of time windows \(t^{st},t^{en}\) up to a maximum window length specified by parameter max_window_length. For calculations of \(s_{min}\) and \(s_{max}\), a time window that has a length specified by parameter sminmax_window_length and ends at time \(t^{en}\). Output the result to the files specified by parameters outputfiles_U, outputfiles_M, and outputfiles_text with the following format.

●パラメータoutputfiles_Uで指定したファイル (Files specified by parameter outputfiles_U)


●パラメータoutputfiles_Mで指定したファイル (Files specified by parameter outputfiles_M)


●パラメータoutputfiles_matrix_infoで指定したファイル (Files specified by parameter outputfiles_matrix_info)


●パラメータoutputfiles_textで指定したファイル (Files specified by parameter outputfiles_text)


◆使用例(Example)

detect_inflation_continuous --inputfiles=data/%YYYY-%MM-%DD.sac --outputfiles_U=result/%YYYY-%MM-%DD.U.bdm --outputfiles_M=result/%YYYY-%MM-%DD.M.bdm --outputfiles_matrix_info=result/%YYYY-%MM-%DD.info.txt --start=2023-10-01.00-00-00 --end=2023-11-15.23-59-59 --file_interval=86400 --sminmax_window_length=3600.0


◆使用上の注意(Note)

出力ファイルのサイズは巨大になる。 テキストファイルは特に巨大であり、 例として1秒刻みでmax_window_length=1800 sの場合、 1日分のデータで14GB(→仮に1年分のデータを処理した場合は5TB)にもなる。 したがってテキストファイルは通常は出力せず (--outputfiles_textオプションなし)、 行列(--outputfiles_U, --outputfiles_Mオプション)についても ファイル容量が小さいcm形式やbdm形式を用いることを推奨する。
The size of the output files may be huge, and this is especially true for the text files. For example, if the data are sampled at 1 s and max_window_length=1800 s, then the size of the output text file for 1 day long data would be as large as 14 GB, and thus that for 1 year long data would be as large as 5 TB. To reduce the size of the output files, usually the text files should not be written (by omitting --outputfiles_text option) and matrix formats with a small size (cm or bdm) should be used for --outputfiles_U and --outputfiles_M options.

◆引用文献 (References)

★ は本プログラムを用いた研究成果の発表時に必ず引用すべき論文を表す。
The star (★) indicates the references that must be cited whenever a research that used this program is published or presented.