sacfile_highpassコマンド マニュアル

(The documentation of sacfile_highpass command)
Last Update: 2024/7/31

◆機能・用途(Purpose)

SAC形式の時系列データにハイパスフィルターを掛ける。
Apply a high-pass filter to a time series data in SAC format.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sac_data/src/sacfile_highpass.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時系列データファイル名。
Name of the input (raw) SAC time series data file.
第2引数
2nd argument 		出力するフィルター後のSAC時系列データファイル名。
Name of the output (filtered) SAC time series data.


●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
cornerFreq フィルターのコーナー周波数(Hz)。
The corner frequency (Hz) of the filter. 		正の実数。
A positive real number. 		省略不可
Cannot be omitted
phase フィルターの位相の種類。
Type of phase of the filter.
  • minimum
    最小位相の(因果律を満たす)フィルターを掛ける。
    Apply a minimum phase (causal) filter.

  • zero
    ゼロ位相のフィルターを掛ける。
    Apply a zero phase filter.

 zero
Npoles フィルターの極の数。 phase=zeroの場合には 時間の順方向と逆方向に1回ずつ漸化式フィルターを掛けるが、 その合計の極の数(1回あたりではない)を指定する。
The number of poles of the filter. In case of phase=zero, recursive filters are applied in normal and reverse directions of time; specify the total (not each) number of poles in this entire process. 		正の整数。 phase=zeroの場合には偶数でなければならない。
A positive integer, which must be an even number in case of phase=zero. 		2


◆動作(Behaviour)

第1引数で指定したSAC時系列データファイルを読み込んでハイパスフィルターを掛け、 得られた時系列データを第2引数で指定したファイルに出力する。 ハイパスフィルターには関数 saito_butterworth_hp(phase=minimumの場合)、 saito_butterworth_hp_zerophase(phase=zeroの場合) を用いる。
Read a SAC time series data specified by the 1st argument, apply a high-pass filter, and output the result into the file specified by the 2nd argument. Function saito_butterworth_hp (in case of phase=minimum) or saito_butterworth_hp_zerophase (in case of phase=zero) is used for the filtering.

◆使用例(Example)

sacfile_highpass raw.sac hp1Hz.sac --cornerFreq=1.0