関数sequence_correlation_C2 マニュアル

(The documentation of function sequence_correlation_C2)
Last Update: 2021/12/7


◆機能・用途(Purpose)

2つの時系列データの相互相関関数を計算する。 相互相関関数の定義として\(C_2(f,g;\tau)\)を用いる。
Compute the cross correlation function (CCF) between two time series data using the definition of \(C_2(f,g;\tau)\).

◆形式(Format)

#include <sequence/correlation.h>
inline struct sequence sequence_correlation_C2
(const struct sequence f,const struct sequence g, const char ∗tau_range)


◆引数(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.
tau_range 計算する相互相関関数の\(\tau\)の範囲。 計算可能な全範囲について計算する場合は"all"とする。 それ以外の場合は計算する\(\tau\)の最小値と最大値を カンマ(,)で区切って与える。
The range of \(tau\) to compute the cross correlation function. To compute the CCF for the entire possible \(\tau\) range, specify "all" for this argument. Otherwise, specify the minimum and maximum values of \(\tau\) separated by a comma (,).


◆戻り値(Return value)

sequence/correlation.hで用いている計算式と理論 の(2)式で定義された\(C_2(f,g;\tau)\)を表す構造体。
A structure indicating \(C_2(f,g;\tau)\) defined by eq. (2) of Formula and theory used in sequence/correlation.h.

◆使用例(Example)

struct sequence data1,data2,correlation;
struct sequence correlation
     =sequence_correlation_C2(data1,data2,"-10.0,10.0");