sequencefile_statisticsコマンド マニュアル

(The documentation of sequencefile_statistics command)
Last Update: 2024/8/19

◆機能・用途(Purpose)

時系列データファイルから統計量(平均値等)を計算・表示する。
Calculate and display statistical quantities (e.g., the average) from a time series data file.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/sequence/src/sequencefile_statistics.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 		調べる時系列データファイル名。
The name of the time series data file to survey.
第2引数
2nd argument 		計算・表示する統計量。以下のいずれかを与える。 以下では時系列データを\(f_k\equiv f(t_0+k\Delta t)\), \(k=0,1,2,\cdots,N-1\)とする。 \(N\)は時系列データの時刻サンプル数、\(t_0\)は先頭時刻、\(\Delta t\)は時間刻み である。
The statistical quantity to compute and display. Choose from one of the followings. Below, the time series data is expressed as \(f_k\equiv f(t_0+k\Delta t)\), \(k=0,1,2,\cdots,N-1\), where \(N\) is the number of time samples, \(t_0\) is the beginning time, and \(\Delta t\) is the sampling interval of the time series data.
  • average
    平均値(\ref{eq.average}式)。
    The average (Eq. \ref{eq.average}).
     \[\begin{equation} a\equiv\frac{1}{N}\sum_{k=0}^{N-1}f_k \label{eq.average} \end{equation}\]
  • sqave
    2乗平均(\ref{eq.sqave}式)。
    The square average (Eq. \ref{eq.sqave}).
     \[\begin{equation} a_2\equiv\frac{1}{N}\sum_{k=0}^{N-1}f_k^2 \label{eq.sqave} \end{equation}\]
  • rms
    2乗平均の平方根(\ref{eq.rms}式)。
    The root mean square (Eq. \ref{eq.rms}).
     \[\begin{equation} RMS\equiv\sqrt{\frac{1}{N}\sum_{k=0}^{N-1}f_k^2}=\sqrt{a_2} \label{eq.rms} \end{equation}\]
  • stddev
    標準偏差(\ref{eq.stddev}式)。
    The standard deviation (Eq. \ref{eq.stddev}).
     \[\begin{equation} \sigma\equiv\sqrt{\frac{1}{N}\sum_{k=0}^{N-1}(f_k-a)^2} =\sqrt{a_2-a^2} \label{eq.stddev} \end{equation}\]


●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
exclude_maxAbsAmp 計算から除外する絶対値振幅が大きいデータの割合。 波形に大振幅のノイズ等が含まれると全体の計算結果に影響するので それを除外するためにこのオプションを用いる。
Ratio of data with large amplitude amplitudes to be excluded. The purpose of this option is to prevend large amplitude noise from affecting computation results. 		1.0未満の非負の実数。
A non-negative real number less than 1.0. 		省略時はデータを除外しない。
No data is excluded if this option is omitted.
tmin 計算に用いる時刻範囲の先頭(s)。
The beginning (s) of the time window used for the computation. 		第1引数で指定した時系列データの定義域内の時刻(s)を表す実数。
A real number that represents time (s) in the definition range of the time series data specified by the 1st argument. 		時系列データの先頭時刻。
The beginning of the time series data.
tmax 計算に用いる時刻範囲の末尾(s)。
The end (s) of the time window used for the computation. 		第1引数で指定した時系列データの定義域内の時刻(s)を表す実数。 パラメータtminの値よりも大きくなければならない。
A real number that represents time (s) in the definition range of the time series data specified by the 1st argument. The value must be greater than that of parameter tmin. 		時系列データの末尾時刻。
The end of the time series data.


◆動作(Behaviour)

第1引数で指定したファイルから時系列データを読み込んで 第2引数で指定した統計量を計算し、標準出力に表示する。
Read the time series data specified by the 1st argument, calculate the statistical quantity specified by the 2nd argument, and display the result into the standard output.

◆使用例(Example)

sequencefile_statistics data.bseq rms