project_3d_dataコマンド マニュアル

(The documentation of project_3d_data command)
Last Update: 2022/3/25

◆機能・用途(Purpose)

3次元データを2次元平面に投影する。
Project a 3-D data onto a 2-D plane.

◆ソースコード(Source code)

$YMAEDA_OPENTOOL_DIR/3d_data/src/project_3d_data.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 		入力(3次元データ)ファイル名。
The input (3-D data) file name.
第2引数
2nd argument 		出力ファイル名。 2次元平面に投影したデータであり、 拡張子は下記の--output_formatオプションに合わせて決める。
The name of the output file, which represents the data projected onto a 2-D plane. The extension needs to be consistent with the --output_format option below.


●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
axis1 投影断面の第1軸。
The 1st axis of the projecting plane. 		x, -x, y, -y, z, -z の6つから選択する。 頭に「-」が付くものを選ぶと座標軸の正負が反転する (1)。
Select from: x, -x, y, -y, z, and -z. Using a choice starting with “-” will reverse the coordinate axis direction. (1) 		省略不可
Cannot be omitted
axis2 投影断面の第2軸。
The 2nd axis of the projecting plane. 		x, -x, y, -y, z, -z の6つから選択する。 第1軸に直交する成分のみ選択できる。 頭に「-」が付くものを選ぶと座標軸の正負が反転する。 (1)
Select from: x, -x, y, -y, z, and -z; however, only the axis directions orthogonal to the 1st axis can be selected. Using a choice starting with “-” will reverse the coordinate axis direction. (1) 		省略不可
Cannot be omitted
mode 投影に際して採用する値。
The values adopted for the projection.
  • min
    投影面に直交する方向に関して最小値を取る。
    Take the minimum value along the direction orthogonal to the projection plane.

  • max
    投影面に直交する方向に関して最大値を取る。
    Take the maximum value along the direction orthogonal to the projection plane.

 min
output_format 出力のフォーマット。
The output format.
  • 3D
    投影面に直交する方向の格子点数が1の3次元データとして出力する。 この場合、出力ファイルの拡張子は3次元データのファイル形式のいずれか でなければならない。 (1)
    Output as a 3-D data having one node in the direction orthogonal to the projection plane. In this case, the extension of the output file must be one of the file formats for 3-D data. (1)

  • plot
    第1軸の座標値を第1列(外側のループ)、 第2軸の座標値を第2列(内側のループ)、 投影したデータ値を第3列としてタブ区切りで書き、 第1軸の座標値が変わる前に空行を入れたテキストファイルとして出力する。 Generic Mapping Tools (GMT)などの描画ソフト を用いたプロットに適している。 この場合、拡張子は何でも良い。
    Output as a text file composed of the 1st coordinate values in the 1st column (outer loop), 2nd coordinate values in the 2nd column (inner loop), and projected data values in the 3rd column. The columns are separated by tabs, and blank lines are inserted immediately before changes of the 1st coordinate value. This format is convenient for plotting by graphic softwares such as Generic Mapping Tools (GMT). In this case, the extension of the output file is arbitrary.

 3D
  1. 出力フォーマットとして「3D」を指定したときは (1)第1軸\(=x\),第2軸\(=y\)、 (2)第1軸\(=x\),第2軸\(=z\)、 (3)第1軸\(=y\),第2軸\(=z\) のいずれかでなければならない。
    When “3D” is selected as the output format, the 1st and axes of the projecting plane must be one of the followings: (1)axis1\(=x\), axis2\(=y\); (2)axis1\(=x\), axis2\(=z\); or (3)axis1\(=y\), axis2\(=z\).


◆動作(Behaviour)

第1引数で指定したファイルから3次元データを読み込み、 2次元平面に投影したデータを第2引数で指定したファイルに出力する。 投影平面は--axis1, --axis2オプション、 投影方法は--modeオプション、 出力ファイルの形式は--output_formatオプションに基づく。
A 3-D data is read from the file specified by the 1st argument. The data is projected onto a 2-D plane, and the result is written into the file specified by the 2nd argument. The projection plane is based on --axis1 and --axis2 options; the projection method is based on the --mode option; and the output file format is based on the --output_format option.

◆使用例(Example)

project_3d_data data.3db data_yz.dat --axis1=-z --axis2=y --output_format=plot

◆追加の情報(Additional information)

3次元データのファイル形式については 独自のファイル形式参照。
For the file formats of a 3-D data, see Special file formats.