関数sequence_correlation_C1_fdomain マニュアル

(The documentation of function sequence_correlation_C1_fdomain)

Last Update: 2021/12/7


◆機能・用途(Purpose)

2つの時系列データの相互相関関数を計算する。 相互相関関数の定義として\(C_1(f,g;\tau)\)を用いる。 計算は周波数領域で行う。
Compute the cross correlation function between two time series data using the definition of \(C_1(f,g;\tau)\). The computation is performed in the frequency domain.


◆形式(Format)

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


◆引数(Arguments)

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


◆戻り値(Return value)

sequence/correlation.hで用いている計算式と理論 の(1)式で定義された\(C_1(f,g;\tau)\)を表す構造体。 \(f(t)\), \(g(t)\)のいずれかの値が全ての時刻で0.0の場合には 全ての\(\tau\)について\(C_1(f,g;\tau)=0.0\)とする。
A structure indicating \(C_1(f,g;\tau)\) defined by eq. (1) of Formula and theory used in sequence/correlation.h. If \(f(t)\) or \(g(t)\) takes zero for all the times, then \(C_1(f,g;\tau)=0.0\) is assumed for all \(\tau\).


◆使用例(Example)

struct sequence data1,data2;
struct sequence correlation=sequence_correlation_C1_fdomain(data1,data2);