sacfile_remove_trendコマンド マニュアル

(The documentation of sacfile_remove_trend command)
Last Update: 2022/11/24

◆機能・用途(Purpose)

SAC時系列データから線形トレンドを差し引く。 一部の区間のみの線形トレンドを差し引くこともできる。
Subtract the linear trend (either in the entire or partial time windows) from a SAC time series data.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sac_data/src/sacfile_remove_trend.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 		入力SACデータファイル名。
The input SAC data file name.
第2引数
2nd argument 		出力するSACファイル名(線形トレンドを差し引いた時系列データの出力先)。 第1引数と同じ名前を指定した場合は上書きされる。
Name of the output SAC file into which the corrected time series data, where the linear trend was subtracted, will be written. If the same name as the 1st argument is specified, the input file will be overwritten.


●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
verbose 画面に出力する情報のレベル。
Choice of the information to be displayed.
  • 0
    何も出力しない。
    Display nothing.

  • 1
    傾きと切片を出力する。
    Display the slope and intercept.

  • 2
    入出力ファイル名と 傾き・切片(全タイムウインドウでの平均) を出力する。
    Display the input and output file names, and the averages of the slopes and intercepts from all time windows.

  • 3
    入出力ファイル名と 傾き・切片(全タイムウインドウでの平均および個々のタイムウインドウ) を出力する。
    Display the input and output file names, the averages and intercepts of the linear trends from all time windows, and those from each time window.

 3
windows 線形トレンドの計算に用いる時間窓。
Time windows used for the computation of the linear trend. 		先頭時刻と末尾時刻の組をカンマ(,)で区切って与える。 それらをアンダーバー(_)で区切って複数与えることもでき、 この場合は時間窓毎の線形トレンドの平均を差し引くことになる。 時刻はSACファイルにおける秒で与える。
Specify a time window by the start and end times, separated by a comma (,). Multiple time windows can be specified, separated by under bars (_); in this case, the average of the linear trends from individual windows is subtracted. Times are based on seconds in the SAC file. 		省略時はSACデータ全体の線形トレンドが差し引かれる。
When omitted, the average of the entire SAC data is removed.


◆動作(Behaviour)

第1引数で指定したSAC時系列データファイルを読み込んで線形トレンドを差し引き、 第2引数で指定したファイルにSAC形式で出力する。
Read the SAC time series data specified by the 1st argument, subtract the linear trend, and output the results as SAC format to the file specified by the 2nd argument.

◆使用例(Example)

sacfile_remove_trend original.sac trend_removed.sac --verbose=0 --windows=0.0,200.0_3500.0,3600.0

この例ではoriginal.sacから [0.0,200.0]と[3500.0,3600.0]の2つの時間窓での 線形トレンドの平均を差し引いて trend_removed.sacに出力する。
In this example, the average of the linear trends in [0.0, 200.0] and [3500.0, 3600.0] windows is subtracted from original.sac and the result is written into trend_removed.sac.

◆使用上の注意(Note)

タイムウインドウ毎に線形トレンドを計算した上で それらの線形トレンドが(タイムウインドウの長さを考慮することなく)差し引かれる。 上の例であれば[0.0,200.0]の線形トレンドと[3500.0,3600.0]の線形トレンドを 足して2で割った値が差し引かれる。 [0.0,200.0]と[3500.0,3600.0]を合わせた 計300秒の時間窓での線形トレンドを差し引きたい場合には --windows=0.0,100.0_100.0,200.0_3500.0,3600.0 のように指定すること。
The linear trends from all windows are simply averaged and subtracted, without taking into account the window lengths. In case of the example above, the value to be subtracted is the summation of the linear trend of [0.0,200.0] and tha of [3500.0,3600.0] divided by 2. To subtract the linear trend of the 300 s window composed of [0.0,200.0] and [3500.0,3600.0], specify as --windows=0.0,100.0_100.0,200.0_3500.0,3600.0.