sacfiles_integral_continuousコマンド マニュアル

(The documentation of sacfiles_integral_continuous command)
Last Update: 2023/11/30

◆機能・用途(Purpose)

複数ファイルに分割されたSAC時系列データを 1つの連続する時系列データと見なして積分する。
Apply a temporal integration to a continuous SAC time series data that is separated into multiple files.
長期間の連続地震波形は通常、 1時間あるいは1日などの時間単位で区切って別々のファイルに格納される。 それら個々のファイル内の波形データを積分する場合、 ファイルの区切り付近において不連続が生じてしまう。 このプログラムの目的なそのような時系列データに対して 連続波形全体が1つの巨大なファイルに格納されている場合と完全に同等の 積分を行うことである。 1つのファイルの最後の時刻での積分値を次のファイルにおいて参照することで これを実現する。
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. Temporal integration to the waveforms in individual files separately results in discontinuity at the boundary times. The purpose of this program is to integrate such data to obtain a waveform exactly identical to what would be obtained by integrating the entire waveform stored in a single, huge file. This is implemented by refering to the integrated value at the last time sample of each file in the processing of the next file.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sac_data/src/sacfiles_integral_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 raw 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 フィルタ後の波形データ(SAC形式)の出力先ファイル名。 入力ファイルと同じ時間区切りが用いられるので通常は複数のファイルになるが、 それらを列挙するのではなく、 日時をパターンとして含む形で命名規則で与える。
The name of the output files for the filtered waveform data (SAC format). 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. 		省略不可
Cannot be 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).


◆動作(Behaviour)

パラメータstartで指定した日時からendで指定した日時までの期間における、 パラメータfile_intervalで指定した時間間隔で区切られた SAC形式の時系列データファイル (パラメータinputfilesで指定したファイル名パターンを持つもの) を順次読み込み、 積分した波形をパラメータoutputfilesで指定したファイルに出力する。 ファイルの区切りをまたいで値が連続になるようにする。
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. Integrate them as a continuous data and output the resultant waveforms into files specified by parameter outputfiles.

◆使用例(Example)

sacfiles_integral_continuous --inputfiles=data_velocity/%YYYY-%MM-%DD.sac --outputfiles=data_displacement/%YYYY-%MM-%DD.sac --start=2023-10-01.00-00-00 --end=2023-11-15.23-59-59 --file_interval=86400

この例では以下のファイルが存在することを仮定している (下記以外の期間のファイルが存在していても構わない)。
This example assumes that the following files are present (no matter if files for periods out of the time range shown below are present).
ファイル
File 		中身
Content
data_velocity/2023-10-01.sac 2023年10月1日の24時間の速度波形データ。
A 24-hour velocity waveform data on October 1, 2023.
data_velocity/2023-10-02.sac 2023年10月2日の24時間の速度波形データ。
A 24-hour velocity waveform data on October 2, 2023.
data_velocity/2023-10-03.sac 2023年10月3日の24時間の速度波形データ。
A 24-hour velocity waveform data on October 3, 2023.
…
data_velocity/2023-11-15.sac 2023年11月15日の24時間の速度波形データ。
A 24-hour velocity waveform data on November 15, 2023.

これらのファイルを順次読み込んで積分し、 結果を下記のファイルに出力する。
These files are sequentially read, integrated, and the results are written into the files listed below.
ファイル
File 		中身
Content
data_displacement/2023-10-01.sac 2023年10月1日の24時間の変位波形データ。
A 24-hour displacement waveform data on October 1, 2023.
data_displacement/2023-10-02.sac 2023年10月2日の24時間の変位波形データ。
A 24-hour displacement waveform data on October 2, 2023.
data_displacement/2023-10-03.sac 2023年10月3日の24時間の変位波形データ。
A 24-hour displacement waveform data on October 3, 2023.
…
data_displacement/2023-11-15.sac 2023年11月15日の24時間の変位波形データ。
A 24-hour displacement waveform data on November 15, 2023.

個々のファイルの波形の積分と異なるのは積分した波形に不連続が無いことである。 個別の波形を積分した場合、2023年10月1日の最後の時刻における変位の値には関係なく 2023年10月2日の最初の時刻の変位は0になる。 一方、上の処理では全期間を通してデータが連続しているものとして積分が行われるので、 2023年10月1日の最後の変位と2023年10月2日の最初の変位は連続になる。
This is different from separately integrating the data in individual files in that the discontinuity does not occur at the times of file boundaries. If individual waveforms are integrated separately, the displacement at the beginning of October 2, 2023, is zero regardless of the displacement at the end of October 1, 2023. On the contrary, this program integrates the waveforms assuming that the data is continuous over the entire period. As a result, the displacements at the end of October 1,2023, and at the beginning of October 2, 2023, are continuous.