sacfiles_rtrend_continuousコマンドマニュアル

(The documentation of sacfiles_rtrend_continuous command)

Last Update: 2024/7/22

◆機能・用途(Purpose)

複数ファイルに分割されたSAC時系列データを1つの連続する時系列データと見なし、移動時間窓で線形トレンドを差し引く。
Subtract the linear trend in a moving window from a continuous SAC time series data that is separated into multiple files.

時系列データから線形トレンドを差し引くことは地震波形の基本的な処理の1つである。しかしゆっくりとしたシグナルを扱う場合、単純に線形トレンドを差し引くと解析対象のシグナルまで差し引いてしまう恐れがある。それを避ける方策の1つがシグナルを含んでいない時間窓のみを用いて線形トレンドを計算し、それを差し引くことである。
Removal of a linear trend from a time series data is one of the basic operations of seismic wave analysis. However, if the signal of interest is slow, simply removing the linear trend may result in subtracting the signal. An approach to avoid this problem is to compute a linear trend in a time window that does not include the singal and subtract it from the original time series data.

このプログラムはこの考え方をシグナルが含まれる時刻が前もって分かっていない長時間の時系列データに対して適用することを意図したものである。元々の時系列データを$f(t)$、区間$[t_1,t_2]$において$f(t)$を直線でフィッティングしたときの傾きを$a[t_1,t_2]$、切片を$b[t_1,t_2]$、 $T(>0)$をユーザ定義の定数として、このプログラムでは \[\begin{equation} g(t)\equiv f(t)-a[t-T,t]t-b[t-T,t] \label{eq.g} \end{equation}\] を計算する。これにより、全ての時刻においてその時刻の前の$T$の長さの時間窓における線形トレンドを $f(t)$から差し引いた時系列データが得られる。
The purpose of this program is to apply this idea to a long time series data that may include signals at unknown times. Let $f(t)$ be the original time series data; $a[t_1,t_2]$ and $b[t_1,t_2]$ are the slope and intercept, respectively, of a fitting straight line of $f(t)$ in a section $[t_1,t_2]$; and $T(>0)$ is a constants defined by the user. The quantity computed by this program is $g(t)$ defined by Eq. (\ref{eq.g}), which gives a time series data obtained by subtracting the linear trend in a time window of length $T$ immediately before each sample time $t$.

長期間の連続地震波形は通常、 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. This program can treat such waveform data, divided into multiple files, as a continuous time series data.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sac_data/src/sacfiles_rtrend_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).
T	線形トレンドを計算する時間窓の長さ(s)。 The length (s) of the time window to compute the linear trend.	パラメータfile_intervalの値以下の実数。 A real number less than or equal to the value of parameter file_interval.	パラメータfile_intervalの値。 The value of parameter file_interval

◆動作(Behaviour)

パラメータstartで指定した日時からendで指定した日時までの期間における、パラメータfile_intervalで指定した時間間隔で区切られた SAC形式の時系列データファイル (パラメータinputfilesで指定したファイル名パターンを持つもの) を順次読み込み、これらを連続した時系列データ$f(t)$と見なして(\ref{eq.g})式の$g(t)$を計算し、パラメータoutputfilesで指定したファイルに出力する。なおパラメータstartで指定した日時からの最初の長さ$T$の区間においてはこの区間の線形トレンドを差し引く。
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 $f(t)$ and compute $g(t)$ in Eq. (\ref{eq.g}). Output the resultant waveforms into files specified by parameter outputfiles. For the first section of length $T$ from the date and time specified by parameter start, the linear trend in this section is subtracted.

◆使用例(Example)

sacfiles_rtrend_continuous --inputfiles=data_original/%YYYY-%MM-%DD.sac --outputfiles=data_detrended/%YYYY-%MM-%DD.sac --start=2023-10-01.00-00-00 --end=2023-11-15.23-59-59 --file_interval=86400 --T=3600.0

この例では以下のファイルが存在することを仮定している (下記以外の期間のファイルが存在していても構わない)。
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_original/2023-10-01.sac	2023年10月1日の24時間の波形データ。 A 24-hour waveform data on October 1, 2023.
data_original/2023-10-02.sac	2023年10月2日の24時間の波形データ。 A 24-hour waveform data on October 2, 2023.
data_original/2023-10-03.sac	2023年10月3日の24時間の波形データ。 A 24-hour waveform data on October 3, 2023.
…
data_original/2023-11-15.sac	2023年11月15日の24時間の波形データ。 A 24-hour waveform data on November 15, 2023.

これらのファイルを順次読み込み、各時刻の前1時間の線形トレンドを差し引いた波形を作成し、結果を下記のファイルに出力する。
These files are sequentially read, a waveform is created by subtracting the linear trend in a time window of the 1 hour before each sample time, and the results are written into the files listed below.

ファイル File	中身 Content
data_detrended/2023-10-01.sac	線形トレンド除去後の2023年10月1日の24時間の波形データ。 A 24-hour detrended waveform data on October 1, 2023.
data_detrended/2023-10-02.sac	線形トレンド除去後の2023年10月2日の24時間の波形データ。 A 24-hour detrended waveform data on October 2, 2023.
data_detrended/2023-10-03.sac	線形トレンド除去後の2023年10月3日の24時間の波形データ。 A 24-hour detrended waveform data on October 3, 2023.
…
data_detrended/2023-11-15.sac	線形トレンド除去後の2023年11月15日の24時間の波形データ。 A 24-hour detrended waveform data on November 15, 2023.

sacfiles_rtrend_continuousコマンド マニュアル