ファイル作成プロパティリスト (File creation property list):
ファイル作成プロパティリストはファイルメタデータの制御に使われます。ファイルメタデータにはユーザーブロック*1のサイズについての情報で成り立ち、様々なファイルのデータ構造のサイズがHDF5ライブラリ等により使われます。このチュートリアルでは、デフォルトのファイル作成プロパティリストであるH5P_DEFAULTが使われます。

ファイルアクセスプロパティリスト (File access property list):
ファイルアクセスプロパティリストはファイルにおいてI/O操作の異なるメソッドの制御に使われます。加えてファイルの閉じられ方の制御にも使う事ができます (あるファイルによる全てのオブジェクトが閉じられるまで、実ファイルのクローズを遅らせるかどうか)。デフォルトのファイルアクセスプロパティリストであるH5P_DEFAULTがこのチュートリアルでは使われます。

ファイルアクセス、作成のプロパティリストとアクセスモードの詳細については H5F section of the HDF5 Users' Guide and Reference Manualを参照してください。

HDF5ファイルの作成と閉じるの手順は以下となります。

ファイル作成とプロパティリストとアアクセスプロパティリストを（必要なら）指定する。
ファイルを作成する。
ファイルと、必要ならプロパティリストも閉じる。

3.2. サンプルプログラム

内容
以下はHDF5ファイルの作成と閉じ方のサンプル*2です。

#include "hdf5.h"
#define FILE "file.h5"

int main(void) {
    hid_t file_id; // ファイル識別子
    herr_t status;

    // デフォルトプロパティでファイルを作成する。
    file_id = H5Fcreate(FILE, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT);

    // ファイルへのアクセスを終わらせる。
    status = H5Fclose(file_id);

    return 0;
}

注記
hdf5.hというヘッダファイルは定義と宣言を含んでいるので、HDF5ライブラリを使うあらゆるプログラムはインクルードする必要があります。

H5Fcreate: HDF5ファイルを作り、ファイル識別子を返します。ファイル作成時に自動的にrootグループが作られます。全てのファイルにはrootグループがあり、rootグループのパス名は必ず/となります。

H5Fclose: HDF5ファイルへのアクセスと終わらせます。HDF5にもうプログラムからアクセスしないならば、ファイルを使用によるリソースを解放するためにH5Fcloseを呼ぶべきです。この呼び出しは必ず行う必要が有ります。

あるファイルに対してH5Fcloseが呼ばれた際に、そのファイルに含まれる1つ以上のオブジェクトがまだ開かれている場合、オブジェクトが個別に閉じられるまで、それらオブジェクトにアクセス可能なままとなります。もしオブジェクトが不注意にも開かれたままだと、これは他のユーザに対するアクセス問題の原因となります。ファイルアクセスプロパティはそのファイルの閉じられ方を制御します。

ファイルの中身
HDF GroupeはHDF5ファイルの中身を調べるためのツールを開発しました。HDF5チュートリアルを通して使われるそのツールはHDF5のダンパーであり、h5dumpと言い、人に読みやすい形に変換してファイルの内容を表示します。h5dumpの出力はHDF5 DDL文法に則る形でのASCII表示です。この文法はHDF5に対してBNF(バッカス・ナウア記法)によるDDL（Data Definition Language, データ定義言語）で定義されています。

HDF5の内容を見るためには以下のように打ち込みます。

$ h5dump <filename>

図4.1はfile.h5の中身を有向グラフで表しています。

f:id:einstee:20160501003759p:plain
図4.1 file.h5の中身

図4.2はfile.h5をテキストで表したものです(h5dumpで作成)。file.h5とよばれるHDF5ファイルは/やルートグループと呼ばれるグループで成り立ちます。

HDF5 "./file.h5" {
GROUP "/" {
}
}

図4.2 DDLでのfile.h5

DDLによるファイル定義
図4.3はHDF5ファイルを作成するための簡略化DDLファイル定義です。簡単のため、簡略化DDLがこのチュートリアル上では使われます。完璧かつ厳密なDDLはHDFに対応するBNFによるDDL、HDF5 User's Guideの項目から見つけることができます。

以下の記号定義がDDLとして使われる。

::=: 定義する

<tname>: tnameという名前を持ったトークン

<a> | <b>: <a>か<b>のどちらか

<a>*: <a>の0以上の出現

ファイル定義の簡略化DDLは以下のようになる:

<file> ::= HDF5 "<file_name>" { <root_group> }

<root_group> ::= GROUP "/" { <group_attribute>* <group_member>* }

<group_attribute> ::= <attribute>

<group_member> ::~ <group> | <dataset>

図4.3 HDF5ファイル定義

*1:ユーザブロックはHDF5ライブラリで無視される、ファイルのはじめの箇所にある固定長ブロックのデータです。ユーザブロックはアプリケーションにとって有益となるデータや情報をを保存するために使用できます。

*2:原文ではCとFORTRAN両方のサンプルがありますが、訳者の都合によりCのみとなります。

2016-05-01

[HDF5] 2. HDF5 API

HDF5 C言語 IT 翻訳

HDF5ライブラリはいくつかのインターフェイスやAPIを提供しています。これらAPIはHDF5ファイルやオブジェクトを作成、アクセス、操作するためのルーチンです。ライブラリ自体はCで実装されています。FORTRAN 90, C++, Jacaプログラマーの仕事をやり易くするために、これら言語毎にHDF5関数のラッパーが開発されています。このチュートリアルではCとFORTRANラッパーを使って話を進めます。

HDF5ライブラリの全CルーチンはH5*という接頭辞で始まり、この*は目的の関数操作に応じた１、２文字の英大文字となります。FORTRANラッパーはh5から始まり_fで終わる形のサブルーチンとなります。
APIを以下に示します。

API	内容
H5	ライブラリ関数群: 一般目的 (general-purpose) のH5関数
H5A	注釈 (Annotation) インターフェイス: 属性のアクセスと操作ルーチン
H5D	データセット (Dataset) インターフェイス: データセットのアクセスと操作ルーチン
H5E	エラー (Error) インターフェイス: エラーハンドリングのルーチン
H5F	ファイル (File) インターフェイス: ファイルアクセスのルーチン
H5G	グループ (Group) インターフェイス: グループの作成と処理のルーチン
H5I	識別子 (Identifier) インターフェイス: 識別子のルーチン
H5L	リンク (Link)インターフェイス: リンクのルーチン
H5O	オブジェクト (Object) インターフェイス: オブジェクトのルーチン
H5P	プロパティリスト(Property List) インターフェイス: オブジェクトプロパティリスト操作のルーチン
H5R	リファレンス(Reference) インターフェイス: 参照のルーチン
H5S	データ空間(Dataspace) インターフェイス: データ空間定義とアクセスのルーチン
H5T	データ型(Datatype) インターフェイス: データ型作成と操作のルーチン
H5Z	圧縮 (Compression) インターフェイス: 圧縮のルーチン

2016-05-01

[HDF5] 1. 基礎的なHDF5ファイル構造

HDF5 C言語 IT 翻訳

HDF5ファイルは色々な科学データを記憶するための容れ物で、主に２つのオブジェクト (groupsとdatasets) から成り立っています。

HDF5 group: ０個以上のHDF5オブジェクトと補助メタデータで構成されるgroup構造
HDF5 dataset: データの多次元配列とその補助メタデータ

あらゆるHDF5 group、datasetに属性(attribute)を付加できま。HDF5 attrtibuteはユーザが定義する、HDF5オブジェクトの追加情報を示すHDF5構造です。

groupsとdatasetsの働きはUNIXのディレクトリとファイルの働きに色々な意味で似ています。UNIXのディレクトリとファイルの様に、HDF5ファイル内のHDFオブジェクトはしばしばフルパス (絶対バスとも) で示されます。

'/'はrootグループを示す。
'/foo'はfooと呼ばれるrootグループのメンバーを示す。
'/foo/zoo'はfooグループのメンバーを示し、fooはrootグループのメンバーである。

2015-04-02

Thinking with Joinsの邦訳 [D3.js]

JavaScript 翻訳 D3.js IT

Joinを考える (Thinking with Joins)

Mike BostockのThinking with Joins (February 5, 2012)の邦訳。ところどころ怪しいです。

2015-03-31

Let’s Make a Bar Chart part 3の邦訳[D3.js]

D3.js JavaScript IT

棒グラフを作ろうその3

November 13, 2013Mike BostocのLet’s Make a Bar Chart, IIIを邦訳したもの。part 2はコチラ。今回の翻訳は意訳が多いので、ご注意ください。

2015-03-24

Let’s Make a Bar Chart part 2の邦訳[D3.js]

IT D3.js JavaScript 翻訳

棒グラフを作ろうその2

November 6, 2013Mike BostocのLet’s Make a Bar Chart, IIを邦訳したもの。part 1はコチラ。

HogeFugaHogera

IT系の備忘録とか、他徒然なるままに

HDF5チュートリアル: 基礎編

3. HDF5ファイルの作成

3.1. HDF5ファイルって何？

3.2. サンプルプログラム

[HDF5] 2. HDF5 API

[HDF5] 1. 基礎的なHDF5ファイル構造

Thinking with Joinsの邦訳 [D3.js]

Joinを考える (Thinking with Joins)

Let’s Make a Bar Chart part 3の邦訳[D3.js]

棒グラフを作ろうその3

Let’s Make a Bar Chart part 2の邦訳[D3.js]

棒グラフを作ろうその2

3.1. HDF5ファイルって何？

3.2. サンプルプログラム

Joinを考える (Thinking with Joins)

棒グラフを作ろう その3

棒グラフを作ろう その2

棒グラフを作ろうその3

棒グラフを作ろうその2