sacfile_correlationコマンド マニュアル

(The documentation of sacfile_correlation command)
Last Update: 2022/8/9

◆機能・用途(Purpose)

2つのSAC時系列データの相互相関関数を計算する。
Compute the cross correlation function (CCF) between two SAC time series data.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sac_data/src/sacfile_correlation.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 		相互相関関数の計算に用いる 1つ目のSAC時系列データ(\(f(t)\))のファイル名。
The file name of the 1st SAC time series data (\(f(t)\)) used for the computation of the CCF.
第2引数
2nd argument 		相互相関関数の計算に用いる 2つ目のSAC時系列データ(\(g(t)\))のファイル名。
The file name of the 2nd SAC time series data (\(g(t)\)) used for the computation of the CCF.
第3引数
3rd argument 		計算した相互相関関数の出力先ファイル名。 このファイルもSAC形式となる。
The file name of the CCF to output. This file is also the SAC format.


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

1つの「-」から始まる引数は自由な順番で指定できる。 「-」から始まらない引数の間に挿入しても良い。 相反する指定がなされた場合には後の指定が優先される。
Arguments beginning with a single “-” 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.
引数
Argument 		動作
Behaviour
-a 下記「--mode=absolute」と同じ。
Same as “--mode=absolute” below.
-r 下記「--mode=relative」と同じ。
Same as “--mode=relative” below.
-s 下記「--mode=startzero」と同じ。
Same as “--mode=startzero” below.
-z 下記「--outofwindow=zero」と同じ。
Same as “--outofwindow=zero” below.
-e 下記「--outofwindow=exclude」と同じ。
Same as “--outofwindow=exclude” below.


●「--パラメータ名=パラメータ値」の形式の引数 (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
mode 時刻の基準の選び方。
Choice of the reference time.
  • absolute
    絶対日時(年月日時分秒)を基準にする。 すなわち、2つの時系列データで日時が一致するときを ラグタイム\(\tau=0\)と定義する。
    The reference time is the absolute date and time (i.e., year, month, day, hour, minute, and second); the lag time \(\tau=0\) means that the dates and times of the two time series data are equal.

  • relative
    絶対日時は参照せず、 2つのSACファイルの基準日時が同一であるものとする。 この場合、SACヘッダのB(No. 005)の値の差が 2つの時系列データの先頭時刻の差であるものとして計算が行われる。
    Absolute dates and times are not referred; instead, the reference time of the two SAC files are assumed to be same. In this case, the difference in the values of SAC header B (No. 005) is regarded as the difference in the beginning times of the two time series data.

  • startzero
    SACファイルの先頭時刻を\(t=0\)として計算を行う。
    Compute the CCF assuming that the beginning times of the two SAC files are \(t=0\).
relative
outofwindow 入力時系列データの定義域外の扱い。
Treatment for outside of the definition ranges of the input time series data. 		zero


◆動作(Behaviour)

第1引数で指定したファイルから読み込んだ時系列データを\(f(t)\)、 第2引数で指定したファイルから読み込んだ時系列データを\(g(t)\)とし、 パラメータoutofwindowの値に応じて \(C_1(f,g;\tau)\)または\(C_2(f,g;\tau)\)を計算し、 結果を第3引数で指定したファイルにSAC形式で出力する。
Compute \(C_1(f,g;\tau)\) or \(C_2(f,g;\tau)\) depending on the value of parameter outofwindow, where \(f(t)\) and \(g(t)\) are the time series data read from files specified by the 1st and 2nd arguments, respectively. The result is written into the file specified by the 3rd argument in the SAC format.

◆使用例(Example)

sacfile_correlation data1.sac data2.sac correlation.sac