blob: ba186a7b2261a25e5199556bc598b338d212cb11 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<HTML><HEAD>
<TITLE>The HDF5 API
</TITLE>
</HEAD>
<body bgcolor="#ffffff">
<!-- BEGIN MAIN BODY -->
<A HREF="http://www.ncsa.uiuc.edu/"><img border=0
src="http://www.ncsa.uiuc.edu/Images/NCSAhome/footerlogo.gif"
width=78 height=27 alt="NCSA"><P></A>
[ <A HREF="title.html"><I>HDF5 Tutorial Top</I></A> ]
<H1>
<BIG><BIG><BIG><FONT COLOR="#c101cd">The HDF5 API</FONT>
</BIG></BIG></BIG></H1>
<hr noshade size=1>
<BODY>
<P>
The HDF5 library provides several interfaces, or APIs.
These APIs provide routines for creating, accessing, and manipulating
HDF5 files and objects.
<P>
The library itself is implemented in C. To facilitate the work of
FORTRAN90 and Java programmers, HDF5 function wrappers have been developed
in each of these languages.
At the time of this writing, a set of C++ wrappers is in development.
This tutorial discusses the use of the C functions and the FORTRAN wrappers.
<P>
All C routines in the HDF5 library begin with a prefix of the form <I>H5</I>*,
where * is one or two uppercase letters indicating the type of object on which the
function operates.
The FORTRAN wrappers come in the form of subroutines that begin with
<I>h5</I> and end with <I>_f</I>. The APIs are listed below:
<P>
<table width="65%" border="2" cellpadding="4">
<tr bgcolor="#FFCC99" bordercolor="#FFFFFF">
<td width="11%">
<div align="center"><b>API </b></div>
</td>
<td width="89%">
<div align="left"><b>DESCRIPTION</b> </div>
</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5</b></div>
</td>
<td width="89%">Library Functions: general-purpose H5 functions</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5A</b></div>
</td>
<td width="89%">Annotation Interface: attribute access and manipulation
routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5D</b></div>
</td>
<td width="89%">Dataset Interface: dataset access and manipulation
routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5E</b></div>
</td>
<td width="89%">Error Interface: error handling routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5F</b></div>
</td>
<td width="89%">File Interface: file access routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5G</b></div>
</td>
<td width="89%">Group Interface: group creation and operation routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5I</b></div>
</td>
<td width="89%">Identifier Interface: identifier routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5P</b></div>
</td>
<td width="89%">Property List Interface: object property list manipulation
routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5R</b></div>
</td>
<td width="89%">Reference Interface: reference routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5S</b></div>
</td>
<td width="89%">Dataspace Interface: dataspace definition and access
routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5T</b></div>
</td>
<td width="89%">Datatype Interface: datatype creation and manipulation
routines</td>
</tr>
<tr bordercolor="#FFFFFF">
<td width="11%" bgcolor="#99CCCC">
<div align="center"><b>H5Z</b></div>
</td>
<td width="89%">Compression Interface: compression routine(s)</td>
</tr>
</table>
<!-- BEGIN FOOTER INFO -->
<P><hr noshade size=1>
<font face="arial,helvetica" size="-1">
<a href="http://www.ncsa.uiuc.edu/"><img border=0
src="http://www.ncsa.uiuc.edu/Images/NCSAhome/footerlogo.gif"
width=78 height=27 alt="NCSA"><br>
The National Center for Supercomputing Applications</A><br>
<a href="http://www.uiuc.edu/">University of Illinois
at Urbana-Champaign</a><br>
<br>
<!-- <A HREF="helpdesk.mail.html"> -->
<A HREF="mailto:hdfhelp@ncsa.uiuc.edu">
hdfhelp@ncsa.uiuc.edu</A>
<br>
Describes HDF5 Release 1.2.2, June 2000
<BR> <H6>Last Modified: December 10, 1999</H6><BR>
<!-- modified by Barbara Jones - bljones@ncsa.uiuc.edu -->
<!-- modified by Frank Baker - fbaker@ncsa.uiuc.edu -->
</FONT>
<BR>
<!-- <A HREF="mailto:hdfhelp@ncsa.uiuc.edu"> -->
</BODY>
</HTML>
|
