The documentation of “sequence/filter.h”

sequence/filter.h マニュアル

(The documentation of sequence/filter.h)

Last Update: 2023/11/30

sequence/filter.hでは時系列データにフィルターを掛ける関数が定義されている。
Functions to apply a filter to a time series data are defined in sequence/filter.h.

このヘッダファイルでは
斎藤正徳 (1978) 「漸化式ディジタル・フィルターの自動設計」 (物理探鉱, Vol. 31, No. 4, pp. 240-263)
のアルゴリズムを主に用いる。なお、同論文にはFortranのコードも載っているが、このヘッダファイルはC言語であり、全く独立に開発したコードである。このヘッダファイルの開発に当たっては同論文の数式上の取り扱いのみを参照した。
This header file mainly uses the algorithm given in the literature below:
Saito, M. (1978), An automatic design algorithm for band selective recursive digital filters, Butsuri-Tanko (Geophys. Explor.), Vol. 31, No. 4, pp. 240-263 (in Japanese with English abstract).
Although Fortran codes are written in that literature, the codes in this header file are written in C and have been developed completely indepentently of the Fortran code in that paper; only the mathematical treatment of the paper was referred in developing this header file.

このヘッダファイル内で定義されている関数を以下に示す。各関数の詳細は関数名をクリックしてリンク先を参照のこと。
Functions to apply a filter to a time series data are defined in sequence/filter.h. Functions defined in this header file are listed below. For details of individual functions, click the links.

関数名 Function name	機能・用途 Purpose
recursive_base	時系列データに基本漸化フィルター (時間領域でのフィルターの基本要素となるフィルター) を掛ける。 Apply an elementary recursive filter (an elementary filter used to construct the other time-domain filters) to a time series data.
recursive_base_continuous	時系列データに基本漸化フィルター (時間領域でのフィルターの基本要素となるフィルター) を掛ける。現在処理中のデータの時間窓の前後にもデータが続いていることを想定して処理する。 Apply an elementary recursive filter (an elementary filter used to construct the other time-domain filters) to a time series data, assuming that the data continues before and after the time window of the currently processed data.
sequence_time_reversal	時系列データを時間反転させる。 Reverse the time order of a time series data.
saito_butterworth_lp	時系列データにButterworthローパスフィルター(最小位相)を掛ける。 Apply a Butterworth low-pass filter (minimum phase) to a time series data.
saito_butterworth_lp_continuous	時系列データにButterworthローパスフィルター(最小位相)を掛ける。現在処理中のデータの時間窓の前後にもデータが続いていることを想定して処理する。 Apply a Butterworth low-pass filter (minimum phase) to a time series data, assuming that the data continues before and after the time window of the currently processed data.
saito_butterworth_lp_zerophase	時系列データにButterworthローパスフィルター(ゼロ位相)を掛ける。 Apply a Butterworth low-pass filter (zero phase) to a time series data.
saito_butterworth_hp	時系列データにButterworthハイパスフィルター(最小位相)を掛ける。 Apply a Butterworth high-pass filter (minimum phase) to a time series data.
saito_butterworth_hp_continuous	時系列データにButterworthハイパスフィルター(最小位相)を掛ける。現在処理中のデータの時間窓の前後にもデータが続いていることを想定して処理する。 Apply a Butterworth high-pass filter (minimum phase) to a time series data, assuming that the data continues before and after the time window of the currently processed data.
saito_butterworth_hp_zerophase	時系列データにButterworthハイパスフィルター(ゼロ位相)を掛ける。 Apply a Butterworth high-pass filter (zero phase) to a time series data.
sequence_lowpassall_zerophase	時系列データから平均値と線形トレンドを除去した上で Butterworthローパスフィルター(ゼロ位相)を掛ける。 Remove the mean and the linear trend from a time series data and apply a Butterworth low-pass filter (zero phase).
sequence_highpassall_zerophase	時系列データから平均値と線形トレンドを除去した上で Butterworthハイパスフィルター(ゼロ位相)を掛ける。 Remove the mean and the linear trend from a time series data and apply a Butterworth high-pass filter (zero phase).
sequence_filterall_zerophase	時系列データから平均値と線形トレンドを除去した上で Butterworthバンドパスフィルター(ゼロ位相)を掛ける。 Remove the mean and the linear trend from a time series data and apply a Butterworth band-pass filter (zero phase).
whiten_spectrum_use_va	フーリエスペクトルを白色化する。パラメータをva_list型変数で与えるバージョン。 Whiten a Fourier spectrum; parameters are given by a va_list-type variable.
whiten_spectrum	フーリエスペクトルを白色化する。パラメータを可変個引数(...)で与えるバージョン。 Whiten a Fourier spectrum; parameters are given by variable-number arguments (...).
whiten_time_series_use_va	時系列データを白色化する。パラメータをva_list型変数で与えるバージョン。 Whiten a time series data; parameters are given by a va_list-type variable.
whiten_time_series	時系列データを白色化する。パラメータを可変個引数(...)で与えるバージョン。 Whiten a time series data; parameters are given by variable-number arguments (...).
sequence_filterall_zerophase_with_whitening 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	時系列データから平均値と線形トレンドを除去した上で白色化し、 Butterworthバンドパスフィルター(ゼロ位相)を掛ける。 From a time series data, remove the mean and the linear trend, then whiten, and then apply a Butterworth band-pass filter (zero phase).
convolve_timefunc 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	時系列データに指定した時間関数をコンボリュージョンする。 Convolve a specified time function with a time series data.
deconvolve_timefunc 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	時系列データから指定した時間関数をデコンボリュージョンする。 Deconvolve a specified time function from a time series data.
sequence_1bit 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	時系列データを1bit化する。元々のデータの符号のみを残す。 Create a 1-bit time series data, by keeping only the sign of a given time series data.