関数TF_check_parameters マニュアル
(The documentation of function TF_check_parameters)
Last Update: 2023/12/11
◆機能・用途(Purpose)
パラメータをチェックする。
Check parameters.
◆形式(Format)
#include "frequency_bessel_sub/parameters.h"
inline void TF_check_parameters(const struct TF_parameters parameters)
◆引数(Arguments)
| parameters |
パラメータ一式。
The parameters.
|
◆動作(Behaviour)
パラメータが以下の条件を満たしているかをチェックし、
満たしていない場合はプログラムをエラー終了する。
Check if the parameters satisfy the requirements listed below;
if any of these requirements are not satisfied,
the program finishes as an error.
- 第1引数が指定されたこと。
The 1st argument must have been specified.
- 第2引数が指定されたこと。
The 2nd argument must have been specified.
- パラメータstation_list_fileが指定されたこと。
Parameter station_list_file must have been specified.
- パラメータindependent_variableの値が"k"の場合、
パラメータcmin, cmax, cincを指定してはならないこと。
If the value of parameter independent_variable is "k",
parameters cmin, cmax, and cinc
must not be specified.
- パラメータindependent_variableの値が"c"の場合、
パラメータkmin, kmax, kincを指定してはならないこと。
If the value of parameter independent_variable is "c",
parameters kmin, kmax, and kinc
must not be specified.
- パラメータindependent_variableの値が
"k"または"c"であること。
The value of parameter independent_variable must be
"k" or "c".
- パラメータkminが指定された場合、その値が正であること。
If parameter kmin was specified,
its value must be positive.
- パラメータkmaxが指定された場合、その値が正であること。
If parameter kmax was specified,
its value must be positive.
- パラメータkincが指定された場合、その値が正であること。
If parameter kinc was specified,
its value must be positive.
- パラメータcminが指定された場合、その値が正であること。
If parameter cmin was specified,
its value must be positive.
- パラメータcmaxが指定された場合、その値が正であること。
If parameter cmax was specified,
its value must be positive.
- パラメータcincが指定された場合、その値が正であること。
If parameter cinc was specified,
its value must be positive.
- パラメータfreq_stepの値が正であること。
The value of parameter freq_step must be positive.
- パラメータnormalizeの値が
"none", "pow2_int", "Nstack",
"ACF", "Nstack_ACF"
のいずれかであること。
The value of parameter normalize must be either
"none", "pow2_int", "Nstack",
"ACF", or "Nstack_ACF".