getdata_on_2D_planeコマンド マニュアル

(The documentation of getdata_on_2D_plane command)
Last Update: 2022/12/1

◆機能・用途(Purpose)

3変数以上に依存するデータセットを元に2次元断面上のデータを取得する。
Obtain data on a 2-D plane from a dataset that depends on 3 or more variables.
データ解析では多数の変数を動かしてサーチする場合が多い。 しかし変数が多いと結果の確認が容易でない。 そこでサーチ結果を元に任意の2変数に対するグラフを作成することを考える。 そのためのデータの作成がこのプログラムで想定している用途である。
In data analyses, it is usual that many variables are involved in a search. Results against these many variables are so complicated that human cannot understand easily. Plotting graphs against arbitrary two variables based on the search results would be a solution for this problem. This program is supposed to be used to create data for these graphs.
例えば地震の断層面の位置(緯度・経度・深さ)、サイズ(長さ・幅)、 向き(走向・傾斜・すべり角)の組合せを様々に変えて 観測データと断層モデルから予測される値との残差を計算し、 これらの8パラメータ(緯度・経度・深さ・長さ・幅・走向・傾斜・すべり角) と残差の関係をテキストファイルにまとめたとする。 そのファイルから
などを抜き出してプロットする場合にこのプログラムを利用できる。
For example, suppose that the residuals between observed data and expected values have been computed for various fault models of an earthquake. Parameters of the fault models consist of the location (latitude, longitude, and depth), size (length and width), and orientations (strike, dip, and rake) of the fault. Varying these parameters, relations between the eight parameters (latitude, longitude, depth, length, width, strike, dip, and rake) and residuals have been computed and summarized as a text file. Now, suppose that you want to plot graphs of the residuals on a latitude-longitude plane, a length-width plane, or a strike-dip plane. To create data for these graphs, this program is available.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/general/src/getdata_on_2D_plane.c


◆使用方法(Usage)

コマンドライン引数でパラメータを指定する。 パラメータの一覧を下表に示す。
Specify parameters by command-line arguments. The table below shows a list of parameters.

●「-」から始まらない引数 (Arguments not beginning with “-”)

引数
Argument 		与える値
Quantity to be given
第1引数
1st argument 		入力ファイル名。 入力ファイルはタブ区切りのテキストファイルとし、 全ての行の列数が等しくなければならない。 同じ列は同じ量(独立変数または従属変数)を表すものと想定される。 なお空行やコメント(#から後ろの部分)は 自由に挿入することができる。
The input file name. The file must be a text file with an equal number of columns (separated by tabs) for all lines. Quantities in the same column are assumed to be same, either an independent or a dependent variable. Empty lines and comments (parts after #) can be inserted at arbitrary places.
第2引数
2nd argument 		出力ファイル名。
The output file name.


●1つの「-」から始まる引数 (Arguments beginning with a single “-”)

このコマンドでは1つの「-」から始まる引数は存在しない。
This command does not have arguments beginning with a single “-”.

●「--パラメータ名=パラメータ値」の形式の引数 (Arguments of a form “--Parameter name=Parameter Value”)

「--パラメータ名=パラメータ値」の形式の引数は自由な順番で指定できる。 「-」から始まらない引数の間に挿入しても良い。 相反する指定がなされた場合には後の指定が優先される。 デフォルト値を持つパラメータは省略できる。
Arguments of a form “--Parameter name=Parameter Value” can be placed in an arbitrary order. They can even be inserted between arguments not beginning with “-”. In case of conflicting options being specified, the latter option has a higher priority. Parameters that have default values can be omitted.
パラメータ名
Parameter name 		意味
Meaning 		可能なパラメータ値
Allowed parameter values 		デフォルト値
Default value
variable1_column 1つ目の独立変数の列番号。
The column number for the 1st independent variable. 		1以上、入力ファイルの列数以下の整数。
An integer greater than or equal to 1 and less than or equal to the number of columns of the input file. 		1
variable2_column 2つ目の独立変数の列番号。
The column number for the 2nd independent variable. 		1以上、入力ファイルの列数以下の整数。
An integer greater than or equal to 1 and less than or equal to the number of columns of the input file. 		2
result_column 取り出したい解析結果(従属変数)の列番号。
The column number for the analysis result to extract (a dependent variable). 		1以上、入力ファイルの列数以下の整数。
An integer greater than or equal to 1 and less than or equal to the number of columns of the input file. 		入力ファイルの最後の列番号。
The final column number of the input file.
method 解析結果の取り出し方。 多数の変数に依存する解析結果から 特定の2つの独立変数に対する結果を抜き出す場合、 2つの独立変数の同一の値の組に対して解析結果の値が複数存在するので、 その中からどのようにして値を取り出すかを指定する。
The method to extract the data. When the analysis result depends on many variables, multiple values of the result are present for the same values of the selected two independent variables. How to compress these multiple values to a single value is specified by this parameter. 		以下のいずれかの値とする。
Choose one of the followings.

  • minimum
    最小値を取り出す。
    Extract the minimum values.

  • maximum
    最大値を取り出す。
    Extract the maximum values.

  • average
    平均値を取り出す。
    Extract the average.

 minimum


◆動作(Behaviour)

出力ファイルは3列からなるタブ区切りのテキストファイルとなる。 第1列はパラメータvariable1_columnで指定した独立変数の値、 第2列はパラメータvariable2_columnで指定した独立変数の値、 第3列はパラメータresult_columnで指定した独立変数の値となる。
The output file is a text file composed of 3 columns separated by tabs. The 1st and 2nd columns represent the values of independent variables specified by parameters variable1_column and variable2_column, respectively, and the 3rd column represents the values of dependent variable specified by parameter result_column.

◆使用例(Example)

getdata_on_2D_plane analysis_result.txt 2D.txt --variable2_column=3 --method=maximum
(analysis_result.txt)
1[TAB]0.1[TAB]0.01[TAB]1.11
1[TAB]0.1[TAB]0.02[TAB]1.12
1[TAB]0.2[TAB]0.01[TAB]1.21
1[TAB]0.2[TAB]0.02[TAB]1.22
2[TAB]0.1[TAB]0.01[TAB]2.11
2[TAB]0.1[TAB]0.02[TAB]2.12
2[TAB]0.2[TAB]0.01[TAB]2.21
2[TAB]0.2[TAB]0.02[TAB]2.22

(2D.txt)
1[TAB]0.01[TAB]1.21
1[TAB]0.02[TAB]1.22
2[TAB]0.01[TAB]2.21
2[TAB]0.02[TAB]2.22

ここで[TAB]はタブを表す。
Here, [TAB] indicates a tab.
この例ではanalysis_result.txtから 第1列を1つ目の独立変数(デフォルト)、 第3列を2つ目の独立変数(--variable2_column=3オプション)、 第4列を計算結果の従属変数(デフォルト) として取り出す。 このとき、例えば第1列が1で第3列が0.01となる結果は2つ(1.11と1.21)存在するが、 --method=maximumの指定により最大値(1.21)が採用される。 その結果、出力ファイル(2D.txt)の第1行では最終列の値が1.21になっている。
In this example, the 1st independent variable from the 1st column (default), the 2nd independent variable from the 3rd column (--variable2_column=3 option), and the independent variable (analysis result) from the 4th column (default) are extracted from analysis_result.txt. Two results (1.11 and 1.21) are present for the 1st column value of 1 and the 3rd column value of 0.01, and the maximum value of them (1.21) is adopted because of the option --method=maximum. As a result, the value of the final column of the 1st line of the output file (2D.txt) is 1.21.