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

(Header files exclusively used by winv command)

Last Update : 2024/7/3

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.

winvコマンドではそれ以外に、このプログラム専用のヘッダファイルを用いている。それらは $YMAEDA_OPENTOOL_DIR/winv/src/winv_sub の下に置いてある。 ymaeda_opentools全体の共通ヘッダファイルと同様に「特殊なヘッダファイル」と「通常のヘッダファイル」がある。
In addition, winv command uses header files exclusively used by this program. These header files are located under $YMAEDA_OPENTOOL_DIR/winv/src/winv_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.

winvコマンド専用の関数や構造体は名前が全て「TF_」から始まる。これはThis Fileの頭文字を取ったものであり、 ymaeda_opentools全体で共通に使用する関数や構造体との名前の重複を避けるために付けている。
The names of all functions and structures exclusively used by winv 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)

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

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

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

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

ヘッダファイル名 Header file name	機能・用途 Purpose
winv_sub/allocate.h	配列の動的メモリを確保する関数。 Functions to allocate dynamic memories for arrays.
winv_sub/fft.h	フーリエ変換を行う関数。 Functions to perform Fourier transformations.
winv_sub/gridsearch.h	グリッドサーチを補助する関数。 Functions to support grid searches.
winv_sub/inversion.h	逆解析を行う関数。 Functions to conduct the inverse analysis.
winv_sub/make_data_seq.h	観測波形の時系列データやフーリエスペクトルを作成する関数。 Functions to create time series data and Fourier spectra of observed waveforms.
winv_sub/make_green_seq.h	実用グリーン関数の時系列データを合成する関数。 Functions to synthesize time series data of practical Green's functions.
winv_sub/polezero.h	地震計の応答特性をファイルから読み込んで処理する関数。 Functions to read and process the responses of seismometers from files.
winv_sub/set_parameters.h	コマンドライン引数やファイルから設定を読み込んで処理する関数。 Functions to read and process configurations from command-line arguments or a file.
winv_sub/spectrum.h	フーリエスペクトルを計算する関数。 Functions to compute Fourier spectra.
winv_sub/write.h	解析結果や関連するデータを出力する関数。 Functions to output the analysis results and related data.

3. 関数の呼び出し構造 (A structure of function call)

winvコマンドのソースコードにおいて、関数は以下のように呼び出される。これは関数の索引にもなっており、関数名をクリックすると直接その関数のマニュアルを閲覧できる。
In the source code of winv 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で用いられている各変数が処理のどの段階で変化するのかを把握することはソースコードの理解の助けになる。そこで、各関数内で変更される変数を緑で示した。
Understanding when each variable in function main changes would facilitate understanding the source code. Therefore, the variables that change in each function are shown by green.

main (winv.c)

TF_set_parameters (winv_sub/set_parameters.h) 【parameters】
TF_read_dataseq_list_file (winv_sub/set_parameters.h) 【dataInfo】
TF_set_polezero_whole (winv_sub/polezero.h) 【dataInfo】
TF_read_modelseq_list_file (winv_sub/set_parameters.h) 【modelInfo】
TF_summarize_focalParam (winv_sub/gridsearch.h) 【focalParam】
TF_make_obs_data (winv_sub/make_data_seq.h) 【obs】
- TF_read_data (winv_sub/make_data_seq.h)
- TF_make_data_obs_spectrum (winv_sub/make_data_seq.h)
TF_prepare_green_kernel (winv_sub/make_green_seq.h) 【kernel】
- TF_allocate_snapshot (winv_sub/allocate.h)
TF_allocate_model (winv_sub/allocate.h) 【model】
TF_allocate_syn (winv_sub/allocate.h) 【syn】
TF_output_data_obs (winv_sub/write.h)
TF_output_data_obs_spectrum (winv_sub/write.h)
TF_output_stfun (winv_sub/write.h)
発震機構パラメータに関するグリッドサーチ内:
(Within grid searches for focal mechanism parameters)
- TF_set_modelInfo_for_gridsearch (winv_sub/gridsearch.h) 【modelInfo】
- TF_set_outputdir_given_focalParam (winv_sub/gridsearch.h) 【focalParam】
- TF_output_residual_header (winv_sub/write.h)
- ソース位置に関するグリッドサーチ内:
  (Within grid searches for the source location)
  - TF_make_green (winv_sub/make_green_seq.h) 【kernel】
    - TF_make_green_point (winv_sub/make_green_seq.h)
      - TF_snapshot2green (winv_sub/make_green_seq.h)
        
        TF_snapshot2green_comp (winv_sub/make_green_seq.h)
  - TF_make_green_spectrum (winv_sub/make_green_seq.h) 【kernel】
  - 周波数に関するループ内:
    (In a loop for frequency)
    - TF_make_data_kernel (winv_sub/inversion.h) 【kernel】
    - TF_inversion_1para (winv_sub/inversion.h) 【model】
    - TF_inversion (winv_sub/inversion.h) 【model】
      - TF_output_SVD (winv_sub/write.h)
      - TF_output_model_resolution_matrix (winv_sub/write.h)
    - TF_output_matrices (winv_sub/write.h)
    - TF_calculate_syn_spectrum (winv_sub/spectrum.h) 【syn】
  - TF_calculate_spectrum_upper_half (winv_sub/spectrum.h) 【model, syn】
  - TF_fift_all (winv_sub/fft.h) 【model, syn】
  - TF_output_green (winv_sub/write.h)
  - TF_output_singular (winv_sub/write.h)
  - TF_output_model (winv_sub/write.h)
  - TF_output_syn (winv_sub/write.h)
  - TF_output_residual (winv_sub/write.h)
  - TF_output_residual_timeDomain (winv_sub/write.h)
  - TF_release_memories (winv_sub/allocate.h) 【kernel, model, syn】

4. 主な変数 (Important variables)

上で緑色で示した変数の値の変化についてより詳しく整理すると以下の通りである。
Changes in the variables, summarized briefly by green colors above, are described in more detail below.

●struct TF_parameters parameters

コマンドライン引数で与えたパラメータ一式、およびそれらの値に基づいて自動計算されるパラメータ一式から成る構造体である。
A structure composed of parameters given by or calculated from command-line arguments.
前処理の中で関数TF_set_parameters を用いて値が設定され、それ以降は変化しない。
The values are determined by function TF_set_parameters in the preprocessings and do not change after that.

●struct TF_dataInfo ∗dataInfo

パラメータdataseq_list_fileで指定したファイルから読み込んだトレースの設定である。
Configurations of traces read from a file specified by parameter dataseq_list_file.
配列であり、dataInfo[n]が$n$番目のトレースの設定を表す。
It is an array, and dataInfo[n] represents the configurations of $n$th trace.
前処理の中で関数 TF_read_dataseq_list_file, TF_set_polezero_whole を用いて値が設定され、それ以降は変化しない。
The values are determined by functions TF_read_dataseq_list_file and TF_set_polezero_whole in the preprocessings and do not change after that.

●struct TF_modelInfo ∗modelInfo

パラメータmodelseq_list_fileで指定したファイルから読み込んだ要素ソースの設定である。
Configurations of elementary sources read from a file specified by parameter modelseq_list_file.
配列であり、modelInfo[m]が$m$番目の要素ソースの設定を表す。
It is an array, and modelInfo[m] represents the configurations of $m$th elementary source.
前処理の中で関数TF_read_modelseq_list_file を用いて値が設定される。メンバname, x, func, dim, ext, NfocalParam, focalParamName, focalParamMin, focalParamMax, focalParamInc, Fx_eqn, Fy_eqn, Fz_eqn, Mxx_eqn, Myy_eqn, Mzz_eqn, Mxy_eqn, Myz_eqn, Mzx_eqn の値はこれ以降変化しない。
The values are determined by function TF_read_modelseq_list_file in the preprocessings. After that, the values of members name, x, func, dim, ext, NfocalParam, focalParamName, focalParamMin, focalParamMax, focalParamInc, Fx_eqn, Fy_eqn, Fz_eqn, Mxx_eqn, Myy_eqn, Mzz_eqn, Mxy_eqn, Myz_eqn, and Mzx_eqn do not change.
$F_p^{(m)}$, $M_{eq}^{(m)}$を発震機構パラメータを含む数式で与える場合、メンバFx, Fy, Fz, Mxx, Myy, Mzz, Mxy, Myz, Mzxの値が発震機構パラメータに関するグリッドサーチのループ内で関数TF_set_modelInfo_for_gridsearch を用いて設定される。これらは発震機構パラメータを具体的に与えたときの $F_p^{(m)}$, $M_{eq}^{(m)}$の値を表し、発震機構パラメータを変える毎に変化する。
If $F_p^{(m)}$ and $M_{eq}^{(m)}$ are given by equations that include focal mechanism parameters, the values of members Fx, Fy, Fz, Mxx, Myy, Mzz, Mxy, Myz, and Mzx are determined by function TF_set_modelInfo_for_gridsearch in a loop for grid searches of focal mechanism parameters. They represent the values of $F_p^{(m)}$ and $M_{eq}^{(m)}$ for given focal mechanism parameters, and thus changes by updating the values of focal mechanism parameters.

●struct TF_focalParam focalParam

発震機構パラメータの情報を表す構造体である。
A structure to express the information of focal mechanism parameters.
メンバN, name, min, max, incは発震機構パラメータの個数、名前、最小値、最大値、増分を表す。これらの値は前処理の中で関数TF_summarize_focalParam を用いて設定され、それ以降は変化しない。
Members N, name, min, max, and inc represent the number, names, minimum values, maximum values, and increments of the focal mechanism parameters. Their values are determined by function TF_summarize_focalParam in the preprocessings and do not change after that.
メンバcurrentValueの値は発震機構パラメータに関するグリッドサーチのループ内で関数mainを用いて直接設定される。グリッドサーチにおける発震機構パラメータの現在の値を表し、ループ内の処理を終える毎に変化する。
The values of member currentValue are determined directly by function main in a loop for grid searches of focal mechanism parameters. They represent the current values of focal mechanism parameters in the grid searches, and change after the processings in each cycle of the loop.
メンバoutputdir_noPath, outputdir_fullの値は発震機構パラメータに関するグリッドサーチのループ内で関数TF_set_outputdir_given_focalParam を用いて設定される。これらは発震機構パラメータを具体的に与えたときの計算結果の出力ディレクトリ名を表し、発震機構パラメータを変える毎に変化する。
The values of members outputdir_noPath and outputdir_full are determined by function TF_set_outputdir_given_focalParam in a loop for grid searches of focal mechanism parameters. They represent the output directory names for the results obtained with given focal mechanism parameters, and thus changes by updating the values of focal mechanism parameters.

●struct TF_data_obs obs

観測データを表す構造体であり、時系列データ、フーリエスペクトル、データベクトルから成る。
A structure to represent the observed data and composed of time series data, Fourier spectra, and data vectors.
前処理の中で関数TF_make_obs_data を用いて値が設定され、それ以降は変化しない。
The values are determined by function TF_make_obs_data in the preprocessings and do not change after that.

●struct TF_kernel kernel

実用グリーン関数やデータ核を表す構造体であり、時系列データ、フーリエスペクトル、行列から成る。
A structure to represent practical Green’s functions and data kernels, and composed of time series data, Fourier spectra, and matrices.
メンバsnapshot_trans, snapshot_tilt, snapshot_xmin, snapshot_dxの値は前処理の中で関数TF_prepare_green_kernel を用いて設定され、それ以降は変化しない。
The values of members snapshot_trans, snapshot_tilt, snapshot_xmin, and snapshot_dx are determined by function TF_prepare_green_kernel in the preprocessings and do not change after that.
メンバgreen, green_trans, green_tiltは2次元配列であり、その動的メモリは前処理の中で関数TF_prepare_green_kernel を用いて確保される。各$n$, $m$に対するgreen[n][m], green_trans[n][m], green_tilt[n][m]は時系列データであり、その動的メモリの確保・解放および値の設定はソース位置に関するグリッドサーチのループ内で関数 TF_make_green, TF_release_memories を用いて行われる。
Members green, green_trans, and green_tilt are 2-D arrays and their dynamic memories are allocated by function TF_prepare_green_kernel in the preprocessings. Members green[n][m], green_trans[n][m], and green_tilt[n][m] for each $n$ and $m$ are time series data; dynamic memories of them are allocated and released and the values of them are determined by functions TF_make_green and TF_release_memories in a loop for grid searches of the source location.
メンバgreen_spectrum, green_trans_spectrum, green_tilt_spectrum は2次元配列であり、その動的メモリは前処理の中で関数TF_prepare_green_kernel を用いて確保される。各$n$, $m$に対するgreen_spectrum[n][m], green_trans_spectrum[n][m], green_tilt_spectrum[n][m]はフーリエスペクトルであり、その動的メモリの確保・解放および値の設定はソース位置に関するグリッドサーチのループ内で関数 TF_make_green_spectrum, TF_release_memories を用いて行われる。
Members green_spectrum, green_trans_spectrum, and green_tilt_spectrum are 2-D arrays and their dynamic memories are allocated by function TF_prepare_green_kernel in the preprocessings. Members green_spectrum[n][m], green_trans_spectrum[n][m], and green_tilt_spectrum[n][m] for each $n$ and $m$ are Fourier spectra; dynamic memories of them are allocated and released and the values of them are determined by functions TF_make_green_spectrum and TF_release_memories in a loop for grid searches of the source location.
メンバG, G_trans, G_tiltは行列であり、その動的メモリは前処理の中で関数TF_prepare_green_kernel を用いて確保される。行列の要素の値は周波数に関するループ内で関数TF_make_data_kernel を用いて設定される。
Members G, G_trans, and G_tilt are matrices and their dynamic memories are allocated by function TF_prepare_green_kernel in the preprocessings. The values of the matrix components are determined by function TF_make_data_kernel in a loop for frequency.

●struct TF_model model

推定したモデルパラメータを表す構造体であり、時系列データ、フーリエスペクトル、モデルベクトル、特異値分解の結果に関する情報から成る。
A structure to represent the estimated model parameters and composed of time series data, Fourier spectra, a model vector, and information of the results of singular value decomposition.
メンバm_estは列ベクトルであり、その動的メモリの確保と値の設定は周波数に関するループ内で関数 TF_inversion, TF_inversion_1para により行われる。動的メモリの解放は同じループ内で関数mainにより直接行われる。
Member m_est is a column vector and its dynamic memory is allocated by functions TF_inversion and TF_inversion_1para in a loop for frequency. The dynamic memory is released directly by function main in the same loop.
メンバspectrumはフーリエスペクトルを全ての要素ソースについて並べた配列であり、 spectrum[m]が$m$番目の要素ソースのフーリエスペクトルを表す。配列およびフーリエスペクトルの動的メモリは前処理の中で関数TF_allocate_model を用いて確保される。フーリエスペクトルの値は周波数に関するループ内で関数mainにより直接設定される。但し、高周波側の半分はソース位置に関するグリッドサーチのループ内で関数TF_calculate_spectrum_upper_half を用いて設定される。
Member spectrum is an array composed of the Fourier spectra for all elementary sources; spectrum[m] represents the Fourier spectrum for $m$th elementary source. Dynamic memories for the array and Fourier spectra are allocated by function TF_allocate_model in the preprocessings. The values of the Fourier spectra are determined directly by function main in a loop for frequency; however, those for the upper half frequencies are determined by function TF_calculate_spectrum_upper_half in a loop for grid searches of the source location.
メンバtimefuncは震源時間関数(時系列データ)を全ての要素ソースについて並べた配列であり、 timefunc[m]が$m$番目の要素ソースの震源時間関数を表す。配列の動的メモリは前処理の中で関数TF_allocate_model を用いて確保される。時系列データの動的メモリの確保・解放および値の設定はソース位置に関するグリッドサーチのループ内で関数 TF_fift_all, TF_release_memories を用いて行われる。
Member timefunc is an array composed of source time functions (time series data) for all elementary sources; timefunc[m] represents the waveform for $m$th elementary source. The dynamic memory for the array is allocated by function TF_allocate_model in the preprocessings. Dynamic memories for the time series data are allocated and released and the values of the data are determined by functions TF_fift_all and TF_release_memories in a loop for grid searches of the source location.
メンバsingularValuesは特異値のリストを全ての周波数について並べた2次元配列、メンバNnonzeroSingularはノンゼロ特異値の個数を全ての周波数について並べた配列である。配列の動的メモリは前処理の中で関数TF_allocate_model を用いて確保される。配列要素の値は周波数に関するループ内で関数 TF_inversion, TF_inversion_1para により設定される。
Member singularValues is a 2-D array composed of the lists of singular values for all frequencies, and member NnonzeroSingular is an array composed of the numbers of non-zero singular values for all frequencies. Dynamic memories for the arrays are allocated by function TF_allocate_model in the preprocessings. The values of the array components are determined by functions TF_inversion and TF_inversion_1para in a loop for frequency.

●struct TF_data_syn syn

推定したモデルパラメータと実用グリーン関数を用いて計算される合成波形を表す構造体であり、時系列データとフーリエスペクトルから成る。
A structure to express time series data or Fourier spectra of synthetic waveforms computed from estimated model parameters and practical Green’s functions.
メンバspectrum, spectrum_trans, spectrum_tilt, spectrum_contribution はフーリエスペクトルから成る配列である。前処理の中で関数TF_allocate_syn を用いて配列の動的メモリおよびフーリエスペクトルの動的メモリが確保される。それぞれの周波数でのフーリエスペクトルの値は周波数に関するループ内で関数TF_calculate_syn_spectrum を用いて設定される。但し、高周波側の半分の要素についてはソース位置に関するグリッドサーチのループ内で関数TF_calculate_spectrum_upper_half を用いて設定される。
Members spectrum, spectrum_trans, spectrum_tilt, and spectrum_contribution are arrays composed of Fourier spectra. Dynamic memories for the arrays and the Fourier spectra are allocated by function TF_allocate_syn in the preprocessings. The values of the spectra at each frequency are determined by function TF_calculate_syn_spectrum in a loop for frequency; however, the values of the upper-half frequency components are determined by function TF_calculate_spectrum_upper_half in a loop for grid searches of the source location.
メンバwaveform, waveform_trans, waveform_tilt, waveform_contribution は時系列データから成る配列である。前処理の中で関数TF_allocate_syn を用いて配列の動的メモリが確保される。時系列データの動的メモリの確保・解放および値の設定はソース位置に関するグリッドサーチのループ内で関数 TF_fift_all, TF_release_memories を用いて行われる。
Members waveform, waveform_trans, waveform_tilt, and waveform_contribution are arrays composed of time series data. Dynamic memories for the arrays are allocated by function TF_allocate_syn in the preprocessings. Dynamic memories of the time series data are allocated and released and the values of them are determined by functions TF_fift_all and TF_release_memories in a loop for grid searches of the source location.
メンバwaveform_lpは時系列データから成る配列である。前処理の中で関数TF_allocate_syn を用いて配列の動的メモリが確保される。時系列データの動的メモリの確保・解放および値の設定はソース位置に関するグリッドサーチのループ内で関数 TF_output_residual_timeDomain, TF_release_memories を用いて行われる。
Member waveform_lp is an array composed of time series data. The dynamic memory for the array is allocated by function TF_allocate_syn in the preprocessings. Dynamic memories of the time series data are allocated and released and the values of them are determined by functions TF_output_residual_timeDomain and TF_release_memories in a loop for grid searches of the source location.