frequency_besselコマンド専用のヘッダファイル

(Header files exclusively used by frequency_bessel command)
Last Update : 2023/12/12

1. 概要 (Overview)

ymaeda_opentoolsでは全てのプログラムで共通に使用するヘッダファイルを $YMAEDA_OPENTOOL_DIR/include の下に置いており、そのマニュアルは ここにある。
Header files commonly used by all programs of ymaeda_opentools are located under $YMAEDA_OPENTOOL_DIR/include, and the documentations for these header files are available from this link.
frequency_besselコマンドではそれ以外に、 このプログラム専用のヘッダファイルを用いている。 それらは $YMAEDA_OPENTOOL_DIR/structural_survey/src/frequency_bessel_sub の下に置いてある。 ymaeda_opentools全体の共通ヘッダファイルと同様に 「特殊なヘッダファイル」と「通常のヘッダファイル」がある。
In addition, frequency_bessel command uses header files exclusively used by this program. These header files are located under $YMAEDA_OPENTOOL_DIR/structural_survey/src/frequency_bessel_sub. There are two classes of header files, “special” and “normal” ones; this feature is same as header files common to the entire ymaeda_opentools.
frequency_besselコマンド専用の関数や構造体は名前が全て「TF_」から始まる。 これはThis Fileの頭文字を取ったものであり、 ymaeda_opentools全体で共通に使用する関数や構造体との 名前の重複を避けるために付けている。
The names of all functions and structures exclusively used by frequency_bessel command begin with “TF_”, which means “This File”, to avoid confliction of the names against functions and structures that are used commonly in the entire ymaeda_opentools.

2. 個々のヘッダファイルのマニュアル (Documentations for individual header files)

以下はfrequency_besselコマンド専用のヘッダファイルのマニュアルである。 ヘッダファイル名は全て $YMAEDA_OPENTOOL_DIR/structural_survey/src の下での相対パスを表す。 リンクをクリックすると各ヘッダファイルのマニュアルを閲覧できる。
The documentations for header files exclusively used frequency_bessel command are shown below. All header files represent relative paths under $YMAEDA_OPENTOOL_DIR/structural_survey/src. Documentations for individual header files are available from the links.

◆特殊なヘッダファイル (Special header files)

ヘッダファイル名
Header file name 		機能・用途
Purpose
frequency_bessel_sub/index.h 他のfrequency_besselコマンド専用ヘッダファイル一式を インクルードするためのヘッダファイル。
A header file to include all other header files exclusively used by frequency_bessel command.
frequency_bessel_sub/structure.h frequency_besselコマンド専用の構造体の定義。
Definitions of structures exclusively used by frequency_bessel command.
frequency_bessel_sub/prototype.h frequency_besselコマンド専用の関数のプロトタイプ。
Prototypes of functions exclusively used by frequency_bessel command.

◆通常のヘッダファイル (Normal header files)

ヘッダファイル名
Header file name 		機能・用途
Purpose
frequency_bessel_sub/calculation.h \(I(\omega,k)\)を計算する関数。
Functions to compute \(I(\omega,k)\).
frequency_bessel_sub/cross_spectrum.h クロススペクトルの読み込みと処理を行う関数。
Functions to read and process the cross spectra.
frequency_bessel_sub/parameters.h パラメータの設定とチェックを行う関数。
Functions to set and check parameters.
frequency_bessel_sub/stations.h 観測点情報を処理する関数。
Functions to process station information.
frequency_bessel_sub/write.h 結果を出力する関数。
Functions to output the results.

3. 関数の呼び出し構造

frequency_besselコマンドのソースコードにおいて、関数は以下のように呼び出される。 これは関数の索引にもなっており、 関数名をクリックすると直接その関数のマニュアルを閲覧できる。
In the source code of frequency_bessel command, functions are called with the tree shown below. This tree can be used for an index of functions; documentations of individual functions are available from the links of the function names.
main (frequency_bessel.c)