関数sequence_decimate_with_mode マニュアル

(The documentation of function sequence_decimate_with_mode)

Last Update: 2024/8/7


◆機能・用途(Purpose)

時系列データのサンプルを間引く。間引き後に用いる値を指定する。
Reduce the samples of a time series data, specifying the values to be used in the resampled data.


◆形式(Format)

#include <sequence/operation.h>
inline struct sequence sequence_decimate_with_mode
(const struct sequence original,const double new_dt,const char ∗mode)


◆引数(Arguments)

original 間引く前の時系列データ(入力)。
The input time series data before the resampling.
new_dt 作成する(間引き後の)時系列データのサンプリング間隔\(\Delta t_{out}\)。 入力時系列データ(引数original)のサンプリング間隔の 整数倍でなければならない。
The sampling interval \(\Delta t_{out}\) of the time series data to create (i.e., after the resampling). This value must be a multiple of the sampling interval of the input time series data given by argument original.
mode 間引き後の時系列データに使用する値。以下のいずれかとする。
Values used in the resampled time series data. Choose from one of the followings.


  • "normal"
    残すサンプル時刻での元々の時系列データの値。 このオプションを選択した場合、戻り値は 関数sequence_decimate の戻り値と同じものになる。
    The value of the original time series data at each remained sample time. If this option is selected, the return value is same as that from function sequence_decimate.

  • "ave"
    区間\([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) での平均値を各サンプル時刻\(t\)での値とする。
    Use the average in section \([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) as the value at each sample time \(t\).

  • "abs_ave"
    区間\([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) での絶対値平均値を各サンプル時刻\(t\)での値とする。
    Use the absolute value average in section \([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) as the value at each sample time \(t\).

  • "max"
    区間\([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) での最大値を各サンプル時刻\(t\)での値とする。
    Use the maximum value in section \([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) as the value at each sample time \(t\).

  • "min"
    区間\([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) での最小値を各サンプル時刻\(t\)での値とする。
    Use the minimum value in section \([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) as the value at each sample time \(t\).

  • "abs_max"
    区間\([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) での絶対値最大値を各サンプル時刻\(t\)での値とする。
    Use the absolute maximum value in section \([t-\Delta t_{out}/2,t+\Delta t_{out}/2]\) as the value at each sample time \(t\).



◆戻り値(Return value)

引数originalで与えた入力時系列データを サンプリング間隔がnew_dtとなるように間引いた時系列データ。 間引き方は引数modeの指定に基づく。
A time series data obtained by resampling the input time series data, given by argument original, to a sampling interval specified by argument new_dt. The method of the resampling is based on the value of argument mode.


◆使用例(Example)

struct sequence pressure; struct sequence pressure_resampled =sequence_decimate(pressure,10.0,"max");


◆補足(Additional information)

この関数は sacfile_decimateコマンド で用いる目的で作成したものである。 引数modeの意図については同コマンドのマニュアル中の「補足」を参照。
This function was created for use in sacfile_decimate command. See “Additional information” in the documentation of that command for the purpose of argument mode.