sacfile_findpeakコマンドマニュアル

(The documentation of sacfile_findpeak command)

Last Update: 2022/5/2

◆機能・用途(Purpose)

SAC時系列データファイルを読み込んで極大値、極小値をリストアップする。
Read a SAC time series data file and list local maxima and minima.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sac_data/src/sacfile_findpeak.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.

●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
-p	下記「--positive=-inf,inf」と同じ。 Same as “--positive=-inf,inf” below.
-n	下記「--negative=-inf,inf」と同じ。 Same as “--negative=-inf,inf” below.
-b	下記「--both=-inf,inf」と同じ。 Same as “--both=-inf,inf” 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
positive	出力に含める極大値の範囲。このパラメータと--bothオプションを省略した場合は極大値が出力されない。 The range of the values of local maxima to output. When this parameter and --both option are omitted, the local maxima are not written.	出力に含める極大値の範囲の下限と上限をカンマ(,)で区切って書く。下限を$-\infty$(制限無し)としたい場合は-inf、上限を$+\infty$(制限無し)としたい場合はinfと書く。 Write the lower and upper limits of the local maxima to output, separated by a comma (,). Use “-inf” to use $-\infty$ (no restriction) for the lower limit, and “inf” to use $\infty$ (no restriction) for the upper limit.
negative	出力に含める極小値の範囲。このパラメータと--bothオプションを省略した場合は極小値が出力されない。 The range of the values of local minima to output. When this parameter and --both option are omitted, the local minima are not written.	出力に含める極小値の範囲の下限と上限をカンマ(,)で区切って書く。下限を$-\infty$(制限無し)としたい場合は-inf、上限を$+\infty$(制限無し)としたい場合はinfと書く。 Write the lower and upper limits of the local minima to output, separated by a comma (,). Use “-inf” to use $-\infty$ (no restriction) for the lower limit, and “inf” to use $\infty$ (no restriction) for the upper limit.
both	出力に含める極大値・極小値の範囲。 The range of the values of local maxima and minima to output.	出力に含める極値の範囲の下限と上限をカンマ(,)で区切って書く。下限を$-\infty$(制限無し)としたい場合は-inf、上限を$+\infty$(制限無し)としたい場合はinfと書く。 Write the lower and upper limits of the local maxima and minima to output, separated by a comma (,). Use “-inf” to use $-\infty$ (no restriction) for the lower limit, and “inf” to use $\infty$ (no restriction) for the upper limit.
snmin	出力に含める極値のシグナル/ノイズ比の下限。対象時刻の$N_s$サンプル前から$N_s$サンプル後までの計$2N_s+1$サンプルの平均値を「シグナル」、対象時刻の$N_n$サンプル前から$N_n$サンプル後までの計$2N_n+1$サンプルの平均値を「ノイズ」とし、シグナル/ノイズ比がこのパラメータの値を超える極値のみを出力する。なお、データの端の近傍においてはデータが存在する範囲のサンプルの平均値で代用される。 $N_s$, $N_n$はパラメータsnwindowで指定する。 The lower limit of the signal-to-noise ratio of the local maxima and minima to output. The “signal” is computed as the average of $2N_s+1$ samples from $N_s$ samples before to $N_s$ samples after the target time, while the “noise” is computed as the average of $2N_n+1$ samples from $N_n$ samples before to $N_n$ samples after the target time. Only the local maxima and minima for which the signal-to-noise ratio exceeds the value of this parameter are written. Near the edges of data, the averages are computed using only available samples. The values of $N_s$ and $N_n$ are specified by parameter snwindow.	実数。負の値を指定すればシグナル/ノイズ比での制限無しとなる。 A real number. A negative value means no restriction for the signal-to-noise ratio.	-1.0
snwindow	パラメータsnminの説明に登場した$N_s$と$N_n$の値。 The values of $N_s$ and $N_n$ that appeared in the description of parameter snmin.	$N_s$と$N_n$の値(非負の整数)をカンマ(,)で区切って並べた文字列。 A string composed of the values of $N_s$ and $N_n$ (non-negative integers) separated by comma (,).	0,1
interval_min	隣接する極値間の最小サンプル数($N_i$)。極大値の前後$N_i$サンプル以内により大きな極大値が存在する場合、極小値の前後$N_i$サンプル以内により小さな極小値が存在する場合はその極値を出力に含めない。 Minimum number of samples ($N_i$) between adjacent local maxima or minima. A local maximum that has another, larger local maximum within $N_i$ samples and a local minimum that has another, smaller local minimum within $N_i$ samples are not written.	非負の整数。0にすれば全ての極大値・極小値が出力される。 A non-negative integer; 0 results in writing all local maxima and minima.	0

--positive, --negative, --bothオプションは少なくとも1つを必ず指定する。というのも、これらは単に値の範囲を指定するものではなく、 --positiveオプションは「極大値を出力する」、 --negativeオプションは「極小値を出力する」、 --bothオプションは「極大値と極小値を出力する」という指定を兼ねているので、これらを与えないと何も出力されない。
At least one of --positive, --negative, or --both option must be specified. This is because these options do not only specify the range of values to output; rather, these options have the role of directive of outputting local maxima, local minima, or both. Therefore omitting these options results in no output.
--snminオプションによるシグナル/ノイズ比の値の範囲の制限を --positive, --negative, --bothオプションによる極大・極小値の範囲の制限と併用した場合には両方の条件を満たす極値のみが出力される。
If the range of output based on signal-to-noise ratios (--snmin option) and the range of output based on values of local maxima and minima (--positive, --negative, or --both option) are specified together, only the local maxima and minima that satisfy the both conditions are written.

◆動作(Behaviour)

引数で指定した条件を満たす極大値と極小値が時刻順に標準出力に表示される。表示内容は第1列が時刻[s]、第2列が極値の値、第3列が極値の種類(p:極大、n:極小)である。 p, nはpositive, negativeの略である。列の区切りにはタブが用いられる。
Local maxima and minima that satisfy the conditions given by arguments are displayed in the standard output in the time order. The output is composed of time [s] in the 1st column, the value of local maxima or minima in the 2nd column, and the distinction of local maxima and minima in the 3rd column; p (positive) in the 3rd column means a local maximum, while n (negative) does a local minimum. Tabs are used to separate the columns.

◆使用例(Example)

●例1 (Example 1)

sacfile_findpeak data.sac -p

この例ではdata.sacに含まれる全ての極大値が出力される。
In this example, all local maxima in data.sac are written.

●例2 (Example 2)

sacfile_findpeak data.sac --positive=1e-05,inf --negative=-inf,-1e-05

この例ではdata.sacに含まれる $1\times 10^{-5}$以上の極大値と $-1\times 10^{-5}$以下の極小値が出力される。
In this example, local maxima greater than or equal to $1\times 10^{-5}$ and local minima less than or equal to $-1\times 10^{-5}$ in data.sac are displayed.

●出力例 (Example of output)

1.230000[TAB]4.567890e-05[TAB]p
45.670000[TAB]-9.876543e-05[TAB]n
56.780000[TAB]-1.010101e-05[TAB]n
67.890000[TAB]-2.102102e-04[TAB]n
198.765432[TAB]2.340000e-05[TAB]p

ここで[TAB]はタブを表す。
Here, [TAB] indicates a tab.

sacfile_findpeakコマンド マニュアル