関数TF_read_parameters マニュアル

(The documentation of function TF_read_parameters)
Last Update: 2023/12/11


◆機能・用途(Purpose)

コマンドライン引数からパラメータを読み込む。
Read parameters from command-line arguments.

◆形式(Format)

#include "frequency_bessel_sub/parameters.h"
inline double TF_read_parameters(int ARGC,char ∗ARGV[])


◆引数(Arguments)

ARGC コマンドライン引数の個数。
The number of command-line arguments.
ARGV コマンドライン引数のリスト。
A list of command-line arguments.


◆戻り値(Return value)

読み込んだパラメータ一式。 戻り値のメンバを下表のように設定する。
The parameters that were read from the arguments. The members of the return value are set as follows.
メンバ
Member		 値
Value
inputdir 第1引数の値。第1引数が与えられていない場合は""。
The value of the 1st argument; if it is not given, the value of this member is "".
outputfile 第2引数の値。第2引数が与えられていない場合は""。
The value of the 2nd argument; if it is not given, the value of this member is "".
station_list_file パラメータstation_list_fileの値。 パラメータstation_list_fileが与えられていない場合は""。
The value of parameter station_list_file; if it is not given, the value of this member is "".
extension パラメータextensionの値。 パラメータextensionが与えられていない場合は"bimseq"。
The value of parameter extension; if it is not given, the value of this member is "bimseq".
independent_variable パラメータindependent_variableの値。 パラメータindependent_variableが与えられていない場合は "k"。
The value of parameter independent_variable; if it is not given, the value of this member is "k".
kmin パラメータkminの値。 パラメータkminが与えられていない場合は不定値 (この関数では値を設定せず、後で 関数TF_set_and_check_parameters_after_readData の中で設定する)。
The value of parameter kmin; if it is not given, the value of this member is later determined in function TF_set_and_check_parameters_after_readData.
kmin_specified パラメータkminが与えられた場合はtrue、与えられていない場合はfalse。
true if parameter kmin was given; false otherwise.
kmax パラメータkmaxの値。 パラメータkmaxが与えられていない場合は不定値 (この関数では値を設定せず、後で 関数TF_set_and_check_parameters_after_readData の中で設定する)。
The value of parameter kmax; if it is not given, the value of this member is later determined in function TF_set_and_check_parameters_after_readData.
kmax_specified パラメータkmaxが与えられた場合はtrue、与えられていない場合はfalse。
true if parameter kmax was given; false otherwise.
kinc パラメータkincの値。 パラメータkincが与えられていない場合は不定値 (この関数では値を設定せず、後で 関数TF_set_and_check_parameters_after_readData の中で設定する)。
The value of parameter kinc; if it is not given, the value of this member is later determined in function TF_set_and_check_parameters_after_readData.
kinc_specified パラメータkincが与えられた場合はtrue、与えられていない場合はfalse。
true if parameter kinc was given; false otherwise.
cmin パラメータcminの値。 パラメータcminが与えられていない場合は不定値 (この関数では値を設定せず、後で 関数TF_set_and_check_parameters_after_readData の中で設定する)。
The value of parameter cmin; if it is not given, the value of this member is later determined in function TF_set_and_check_parameters_after_readData.
cmin_specified パラメータcminが与えられた場合はtrue、与えられていない場合はfalse。
true if parameter cmin was given; false otherwise.
cmax パラメータcmaxの値。 パラメータcmaxが与えられていない場合は不定値 (この関数では値を設定せず、後で 関数TF_set_and_check_parameters_after_readData の中で設定する)。
The value of parameter cmax; if it is not given, the value of this member is later determined in function TF_set_and_check_parameters_after_readData.
cmax_specified パラメータcmaxが与えられた場合はtrue、与えられていない場合はfalse。
true if parameter cmax was given; false otherwise.
cinc パラメータcincの値。 パラメータcincが与えられていない場合は不定値 (この関数では値を設定せず、後で 関数TF_set_and_check_parameters_after_readData の中で設定する)。
The value of parameter cinc; if it is not given, the value of this member is later determined in function TF_set_and_check_parameters_after_readData.
cinc_specified パラメータcincが与えられた場合はtrue、与えられていない場合はfalse。
true if parameter cinc was given; false otherwise.
freq_step パラメータfreq_stepの値。 パラメータfreq_stepが与えられていない場合は1。
The value of parameter freq_step; if it is not given, the value of this member is 1.
normalize パラメータnormalizeの値。 パラメータnormalizeが与えられていない場合は"Nstack_ACF"。
The value of parameter normalize; if it is not given, the value of this member is "Nstack_ACF".
Nstations この関数では値を設定せず、後で関数mainの中で設定する。
The value of this member is later determined in function main.
Nf この関数では値を設定せず、後で関数 TF_check_cross_spectrum、 TF_modify_cross_spectrum の中で設定する。
The value of this member is later determined in functions TF_check_cross_spectrum and TF_modify_cross_spectrum.
f0 この関数では値を設定せず、後で関数 TF_check_cross_spectrum、 TF_modify_cross_spectrum の中で設定する。
The value of this member is later determined in functions TF_check_cross_spectrum and TF_modify_cross_spectrum.
df この関数では値を設定せず、後で関数 TF_check_cross_spectrum、 TF_modify_cross_spectrum の中で設定する。
The value of this member is later determined in functions TF_check_cross_spectrum and TF_modify_cross_spectrum.
Npairs この関数では値を設定せず、後で 関数TF_list_existing_pairs の中で設定する。
The value of this member is later determined in function TF_list_existing_pairs.
Nkc この関数では値を設定せず、後で関数mainの中で設定する。
The value of this member is later determined in function main.