関数sequence_correlation_noshift マニュアル

(The documentation of function sequence_correlation_noshift)

Last Update: 2021/12/7

◆機能・用途(Purpose)

2つの時系列データの相互相関関数のラグタイム\(\tau=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 (\(\tau=0\)).

◆形式(Format)

#include <sequence/correlation.h>
inline double sequence_correlation_noshift
(const struct sequence f,const struct sequence g)

◆引数(Arguments)

f	相互相関関数の計算に用いる1つ目の時系列データ\(f(t)\)。 The 1st time series data, \(f(t)\), used to compute the CCF.
g	相互相関関数の計算に用いる2つ目の時系列データ\(g(t)\)。 The 2nd time series data, \(g(t)\), used to compute the CCF.

◆戻り値(Return value)

sequence/correlation.hで用いている計算式と理論の(1)式で定義された\(C_1(f,g;0)\)の値。
The value of \(C_1(f,g;0)\) defined by eq. (1) of Formula and theory used in sequence/correlation.h.

◆使用例(Example)

struct sequence data1,data2;
double correlation=sequence_correlation_noshift(data1,data2);