The documentation of “sequence/correlation.h”

sequence/correlation.h マニュアル

(The documentation of sequence/correlation.h)

Last Update: 2021/12/7

sequence/correlation.hでは 2つの時系列データの相互相関関数を計算する関数が定義されている。計算に使用する2つの時系列データのサンプリング間隔は共通でなければならないが、定義域やその長さは互いに異なっていても構わない。その結果、様々な相互相関関数の定義が考えられる。詳細は sequence/correlation.hで用いている計算式と理論を参照のこと。
Functions to calculate cross correlation functions (CCFs) between two time series data are defined in sequence/correlation.h. The two time series data must have the same sampling interval, but may have different definition ranges and lengths. As a result, there may be various definitions of CCFs. See Formula and theory used in sequence/correlation.h for detail.

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

関数名 Function name	機能・用途 Purpose
sequence_correlation_numerator_fdomain	2つの時系列データの相互相関関数の分子を計算する。計算は周波数領域で行う。 Compute the numerator of the cross correlation function between two time series data. The computation is performed in the frequency domain.
sequence_correlation_C1_fdomain	2つの時系列データの相互相関関数を計算する。相互相関関数の定義として $C_{1} (f, g; τ)$ を用いる。計算は周波数領域で行う。 Compute the cross correlation function between two time series data using the definition of $C_{1} (f, g; τ)$ . The computation is performed in the frequency domain.
sequence_correlation_C2	2つの時系列データの相互相関関数を計算する。相互相関関数の定義として $C_{2} (f, g; τ)$ を用いる。 Compute the cross correlation function between two time series data using the definition of $C_{2} (f, g; τ)$ .
sequence_correlation_noshift	2つの時系列データの相互相関関数のラグタイム $τ = 0$ での値 $C_{1} (f, g; 0)$ を計算する。 Compute the value of the cross correlation function, $C_{1} (f, g; 0)$ , between two time series data for zero time lag ( $τ = 0$ ).
sequence_correlation_noshift_limittime	2つの時系列データの相互相関関数のラグタイム $τ = 0$ での値 $C_{1} (f, g; 0)$ を計算する。使用する時系列データの時刻範囲を限定して計算を行う。 Compute the value of the cross correlation function, $C_{1} (f, g; 0)$ , between two time series data for zero time lag ( $τ = 0$ ), limiting the time windows of the time series data to use.