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

(Header files exclusively used by detect_VLP command)
Last Update : 2022/8/8

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.
detect_VLPコマンドではそれ以外に、 このプログラム専用のヘッダファイルを用いている。 それらは $YMAEDA_OPENTOOL_DIR/event_detection/src/detect_VLP_sub の下に置いてある。 ymaeda_opentools全体の共通ヘッダファイルと同様に 「特殊なヘッダファイル」と「通常のヘッダファイル」がある。
In addition, detect_VLP command uses header files exclusively used by this program. These header files are located under $YMAEDA_OPENTOOL_DIR/event_detection/src/detect_VLP_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.
detect_VLPコマンド専用の関数や構造体は名前が全て「TF_」から始まる。 これはThis Fileの頭文字を取ったものであり、 ymaeda_opentools全体で共通に使用する関数や構造体との 名前の重複を避けるために付けている。
The names of all functions and structures exclusively used by detect_VLP 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)

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

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

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

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

ヘッダファイル名
Header file name 		機能・用途
Purpose
detect_VLP_sub/event_info.h 各イベント候補に関して様々な量を計算し、 VLPイベントか否かを判断する関数。
Functions to compute various quantities for each event candidate and determine if it is a true VLP event.
detect_VLP_sub/file.h ファイルをオープン・クローズする関数。
Functions to open and close files.
detect_VLP_sub/set_parameters.h パラメータの設定とチェックを行う関数。
Functions to set and check parameters.
detect_VLP_sub/write.h 結果を出力する関数。
Functions to output the results.

3. 関数の呼び出し構造

detect_VLPコマンドのソースコードにおいて、関数は以下のように呼び出される。 これは関数の索引にもなっており、 関数名をクリックすると直接その関数のマニュアルを閲覧できる。
In the source code of detect_VLP 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 (detect_VLP.c)