sacfile_whitenコマンドマニュアル

(The documentation of sacfile_whiten command)

Last Update: 2023/6/27

◆機能・用途(Purpose)

SAC時系列データファイルを読み込んで周波数成分を白色化する。
Read a SAC time series data file and whiten the frequency contents.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sac_data/src/sacfile_whiten.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 whitened time series data 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
method	白色化の方法。 The method of the whitening.	関数whiten_spectrum における引数methodの選択肢のいずれかを指定する。 Specify one of the choices for the argument method of function whiten_spectrum.	average
Nave	method=averageの場合において白色化に用いるサンプル数。各周波数でのスペクトル成分をその周波数を中心とするNaveサンプルの平均振幅スペクトルで割ることで白色化する。 The number of samples used for the whitening in case of method=average. The whitening is implemented by dividing each frequency sample of a spectrum by the average amplitude over Nave samples centered on the frequency.	入力時系列データのデータサンプル数の半分よりも小さな正の奇数。 A positive odd number less than half the number of data samples of the input time series data.	3

◆動作(Behaviour)

第1引数で指定したSAC時系列データファイルを読み込んで白色化し、第2引数で指定したファイルにSAC形式で出力する。
Read the SAC time series data specified by the 1st argument, whiten the time series data, and output the results as SAC format to the file specified by the 2nd argument.

◆使用例(Example)

sacfile_whiten original.sac whitened.sac --method=average --Nave=5

◆使用上の注意(Note)

入力データの時刻サンプル数が2の巾乗でない場合、 2の巾乗になるように末尾にダミーの0が付加された上で白色化が行われる。これにより、先頭・末尾付近の時刻において白色化後の時系列データに大きな人為的シグナルを生じやすい。対策として、入力データの先頭・末尾部に事前にテーパーを掛けておくことを推奨する。
If the number of time samples of the input data is not a power of 2, dummy zeroes are appended at the end to make the number a power of 2 before the whitening. This readily causes large artificial signals near the beginning and end times in the whitened time series data. A recommended countermeasure to this problem is the tapering to the beginning and end parts of the input time series data before passing the data to this program.
末尾に付加されたダミーの0に対応する時刻のデータを含めて白色であるので、その部分をカットして元の時系列データと同じ時刻範囲にしてしまうと白色にはならない点に留意。
The spectrum is white including the dummy zero time window appended at the end. If the user cuts this window to make the whitened time series data extending over the same window as the input time series data, the result would no longer be white.

sacfile_whitenコマンド マニュアル