The documentation of “3d_data/readwrite.h”

3d_data/readwrite.h マニュアル

(The documentation of 3d_data/readwrite.h)

Last Update: 2023/7/10

3d_data/readwrite.hでは struct _3d_data型構造体のファイル入出力を行う関数が定義されている。
Functions to read and write a struct _3d_data-type structure from/to a file are defined in 3d_data/readwrite.h.

ymaeda_opentoolsでは struct _3d_data型構造体の入出力ファイル形式として様々なものを定義しており、独自のファイル形式に説明がある。 3d_data/readwrite.hでは各ファイル形式毎の入出力関数と、それらを呼び出すための親関数を定義している。例えば3d形式のファイルを読み込むための関数としてread_3d_data_3dがあり、 3d形式を含むあらゆる形式のファイルを読み込むための親関数としてread_3d_dataがある。ファイル形式毎の関数(read_3d_data_3dなど)は親関数(read_3d_dataなど)からの内部呼び出し用であり、ユーザが直接用いることを想定していないためエラーチェック機能が十分ではない。そのためユーザは通常、ファイル形式毎の関数(read_3d_data_3dなど)を直接用いることは避け、親関数(read_3d_dataなど)を用いるべきである。
In ymaeda_opentools various input/output file formats are defined for a struct _3d_data-type structure; see Special file formats for detail. In 3d_data/readwrite.h, input/output functions for individual file formats are defined, as well as parent functions from which these individual functions are called. For example, a function read_3d_data_3d is defined for reading a file of 3d format, and a parent function read_3d_data is defined to read all file types including 3d. The functions for individual file formats (e.g., read_3d_data_3d) are for internal calls from the parent functions (e.g., read_3d_data); in the former function groups, direct use by the users is not assumed, and error checks are very limited. For this reason, users should avoid directly using the functions for individual file formats (e.g., read_3d_data_3d) and should instead use the parent functions (e.g., read_3d_data_3d).

このヘッダファイル内で定義されている関数を以下に示す。各関数の詳細は関数名をクリックしてリンク先を参照のこと。
Functions defined in this header file are listed below. For details of individual functions, click the links.

関数名 Function name	機能・用途 Purpose	使用上の注意 Note
read_3d_data	struct _3d_data型構造体を任意の形式のファイルから読み込む。各形式のファイルを読み込む関数を呼び出すための親関数。 Read a struct _3d_data-type structure from a file of arbitrary formats; a parent function from which functions for individual file formats are called.
read_3d_data_3d 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3d形式のファイルから読み込む。 Read a struct _3d_data-type structure from a file of 3d format.	エラーチェック機能が不十分なので直接用いるべきではない。関数read_3d_dataを用いること。 These functions should not be used directly, as the error checks are limited. Use function read_3d_data instead.
read_3d_data_3db 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3db形式のファイルから読み込む。 Read a struct _3d_data-type structure from a file of 3db format.
read_3d_data_3dx 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3dx形式のファイルから読み込む。 Read a struct _3d_data-type structure from a file of 3dx format.
read_3d_data_3dy 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3dy形式のファイルから読み込む。 Read a struct _3d_data-type structure from a file of 3dy format.
read_3d_data_3dz 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3dz形式のファイルから読み込む。 Read a struct _3d_data-type structure from a file of 3dz format.
read_3d_data_3ds 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3ds形式のファイルから読み込む。 Read a struct _3d_data-type structure from a file of 3ds format.
write_3d_data	struct _3d_data型構造体を任意の形式のファイルに出力する。各形式のファイルを出力する関数を呼び出すための親関数。 Write a struct _3d_data-type structure to a file of arbitrary formats; a parent function from which functions for individual file formats are called.
write_3d_data_3d 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3d形式のファイルに出力する。 Write a struct _3d_data-type structure to a file of 3d format.	エラーチェック機能が不十分なので直接用いるべきではない。関数write_3d_dataを用いること。 These functions should not be used directly, as the error checks are limited. Use function write_3d_data instead.
write_3d_data_3db 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3db形式のファイルに出力する。 Write a struct _3d_data-type structure to a file of 3db format.
write_3d_data_3dx 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3dx形式のファイルに出力する。 Write a struct _3d_data-type structure to a file of 3dx format.
write_3d_data_3dy 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3dy形式のファイルに出力する。 Write a struct _3d_data-type structure to a file of 3dy format.
write_3d_data_3dz 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を3dz形式のファイルに出力する。 Write a struct _3d_data-type structure to a file of 3dz format.
read_snapshot 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	一定の時間間隔でサンプリングされた、各時刻での3次元データファイルから成るファイル群(スナップショット)を struct _3d_data型構造体から成る配列に読み込む。 Read a series of files representing 3-D data at individual time samples that are evenly sampled, called “snapshots”, to an array of struct _3d_data-type structures.
write_3d_data_section_for_plot 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	struct _3d_data型構造体を元に2次元断面上のデータを作成し、プロットしやすい形式で出力する。 Create data on a 2-D section from a struct _3d_data-type structure, and output the result in an easy-to-plot format.