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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
|
<html>
<head>
<a name="TopofRM"></a>
<title>
HDF5 API Specification
</title>
<link href="../ed_styles/RMelect.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#FFFFFF">
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://www.hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<!-- #EndLibraryItem --><!-- HEADER LEFT "HDF5 Reference Manual -->
<!-- FOOTER $PAGE (format=1) -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" -->
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="../index.html">HDF5 documents and links</a> <br>
<a href="../H5.intro.html">Introduction to HDF5</a> <br>
<a href="../UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
In the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<font size="-1"><br>
<a href="../HL/RM_H5DS.html">H5DS</a>
<a href="../HL/RM_H5IM.html">H5IM</a>
<a href="../HL/RM_H5LT.html">H5LT</a>
<a href="../HL/RM_H5PT.html">H5PT</a>
<a href="../HL/RM_H5TB.html">H5TB</a>
<a href="../HL/RM_HDF5Optimized.html">Optimized</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<br>
<a href="RM_H5L.html">H5L</a>
<a href="RM_H5O.html">H5O</a>
<a href="RM_H5P.html">H5P</a>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<br>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
<a href="../fortran/index.html">Fortran</a>
<a href="APICompatMacros.html">Compatibility Macros</a>
<br>
<a href="CollectiveCalls.html">Collective Calls in Parallel</a>
</font>
<!--
<br>
<i><font size=-1>(Printable <a href="http://hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF">PDF</a> of this Reference Manual)</font></i>
-->
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><center>
<h1>HDF5: API Specification<br>Reference Manual</h1>
</center>
The HDF5 library provides several interfaces, each of which provides the
tools required to meet specific aspects of the HDF5 data-handling requirements.
<SCRIPT language="JavaScript">
<!--
document.writeln("See <a href="#F90andCPPlus">below</a> for the Fortran and C++ APIs.")
-->
</SCRIPT>
<!-- FOR USE WITH PRINT VERSION ONLY -----------------------------------
<p>
Notes regarding Fortran and C++ APIs appear on the next page.
<!-- FOR USE WITH PRINT VERSION ONLY ----------------------------------->
<SCRIPT language="JavaScript">
<!--
document.writeln('<center>\
<table border="1" width="80%">\
<tr align="center" valign="middle">\
<td width="33%"><a href="#HighLevelAPIs">High-level APIs</a></td>\
<td width="34%"><a href="#LowLevelAPIs">Main HDF5 Library,\
<br>including Low-level APIs</a></td>\
<td width="33%"><a href="#F90andCPPlus">Fortran and C++\
<br>Interfaces</a></td>\
</tr>\
</table>\
</center>\
')
-->
</SCRIPT>
<br>
<a name="HighLevelAPIs"><br></a>
<center>
<table border="0" width="100%">
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<tr>
<td valign="top" colspan="4">
<h3>High-level HDF5 APIs</h3>
The HDF5 Library includes several sets of convenience and
standard-use APIs.
The HDF5 Lite APIs are convenience functions designed to
facilitate common HDF5 operations.
The HDF5 Image, HDF5 Table and HDF5 Packet Table APIs
implement standardized approaches to common use cases
with the intention of improving interoperability.
</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top width="10%"><a href="../HL/RM_H5LT.html">Lite</a></td>
<td width="5%"> </td>
<td valign=top width="60%">The <strong>H5LT</strong>
API<b><strong> </strong></b>general higher-level functions</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="../HL/RM_H5IM.html">Image</a></td>
<td> </td>
<td valign=top>The <strong>H5IM</strong> API for images</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="../HL/RM_H5TB.html">Table</a></td>
<td> </td>
<td valign=top>The <strong>H5TB</strong> API for manipulating
table datasets </td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="../HL/RM_H5PT.html">Packet Table</a></td>
<td> </td>
<td valign=top>The <strong>H5PT</strong> API for managing packet tables
<br>
(and the <a href="../HL/RM_H5PT_c++.html">C++ H5PT wrappers</a>)
</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="../HL/RM_H5DS.html">Dimension Scales</a></td>
<td> </td>
<td valign=top>The <strong>H5DS</strong> API for managing
dimension scales </td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="../HL/RM_HDF5Optimized.html">Optimized
Functions</a></td>
<td> </td>
<td valign=top>Specialized HDF5 performance-optimized functions,
generally requiring careful setup and testing </td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="http://www.hdfgroup.org/projects/jpss/documentation/HL/RM/index.html">Extensions</a></td>
<td> </td>
<td valign=top>High-level HDF5 functions for working with region references,
simple hyperslabs, and bitfields. </td>
</tr>
<!-- END USE WITH ELECTRONIC VERSION -->
<tr>
<td valign="top" width="10%"> </td>
<td> </td>
<td> </td>
<td><a name="LowLevelAPIs"> </a></td>
</tr>
<tr>
<td valign="top" colspan="4">
<h3>Main HDF5 Library, or Low-level APIs</h3>
The main HDF5 Library includes all of the low-level APIs,
providing user applications with fine-grain control of
HDF5 functionality.
</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5.html">Library Functions</a></td>
<td> </td><td valign=top>The general-purpose
<strong>H5</strong> functions.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5A.html">Attribute Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5A</strong> API for attributes.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5D.html">Dataset Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5D</strong> API for manipulating
scientific datasets.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5E.html">Error Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5E</strong> API for error handling.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5F.html">File Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5F</strong> API for accessing
HDF5 files.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5G.html">Group Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5G</strong> API for creating physical
groups of objects on disk.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5I.html">Identifier Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5I</strong> API for working with
object identifiers.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5L.html">Link Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5L</strong> API for working with
links.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5O.html">Object Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5O</strong> API for manipulating
objects and reference counts.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5P.html">Property List Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5P</strong> API for manipulating
object property lists.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5R.html">Reference Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5R</strong> API for references.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5S.html">Dataspace Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5S</strong> API for defining dataset
dataspace.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5T.html">Datatype Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5T</strong> API for defining dataset
element information.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="RM_H5Z.html">Filters and</a><br>
<a href="RM_H5Z.html">Compression Interface</a></td>
<td> </td>
<td valign=top>The <strong>H5Z</strong> API for inline data filters
and data compression.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="Tools.html">Tools</a></td>
<td> </td>
<td valign=top>Interactive tools for the examination
of existing HDF5 files.</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="PredefDTypes.html">Predefined Datatypes</a></td>
<td> </td>
<td valign=top>Predefined datatypes in HDF5.
<!--
</td></tr>
<tr><td valign=top><a href="Glossary.html">Glossary</a>
</td><td></td><td valign=top>A glossary of data-types used in the APIs.
-->
</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="../fortran/FortranFlags.html">HDF5 Fortran Flags,</a><br>
<a href="../fortran/FortranFlags.html">Helper Functions, </a><br>
<a href="../fortran/FortranFlags.html">Datatypes, User Notes</a></td>
<td> </td>
<td valign=top>Flags and datatypes used in the HDF5 Fortran interface.
<br>User notes for the HDF5 Fortran interface.
</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="APICompatMacros.html">API Compatibility</a><br>
<a href="APICompatMacros.html">Macros</a></td>
<td> </td>
<td valign=top>API compatibility macros provided in HDF5.
</td>
</tr>
<tr>
<td valign="top" width="10%"> </td>
<td valign=top><a href="CollectiveCalls.html">Collective Calling</a><br>
<a href="CollectiveCalls.html">Requirements</a></td>
<td> </td>
<td valign=top>Requirements for collective function calls and
coordinated use<br>of properties in parallel HDF5 applications.
</td>
</tr>
</table>
</center>
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<!--
<p>
A PDF version of this <cite>HDF5 Reference Manual</cite> will be available
from <a href="http://www.hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF">
<code>http://www.hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF</code></a>
approximately one week after each release.
-->
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<!-- -->
<!-- NEW PAGE -->
<a name="F90andCPPlus">
<hr>
<SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("<div align=right><a href='#TopofRM'>To top of <cite>Reference Manual</cite></a></div>");
-->
</SCRIPT>
<h3>The Fortran and C++ APIs to HDF5</h3>
</a>
The HDF5 Library distribution includes Fortran and C++ APIs,
which are described in the following documents.
<p>
<strong>Fortran API</strong>
<dir>
<u>Fortran APIs in the <cite>HDF5 Reference Manual</cite>:</u>
The <cite>HDF5 Reference Manual</cite> includes
descriptions of the HDF5 Fortran APIs.
Fortran subroutines exist in the H5, H5A, H5D, H5E, H5F, H5G, H5I, H5P,
H5R, H5S, H5T, and H5Z interfaces and are described on those pages.
In general, each Fortran subroutine performs exactly the same task
as the corresponding C function, with which it is described.
<p>
See <cite><a href="../fortran/index.html">HDF5 Fortran Interface</a></cite>
for a complete description of the HDF5 Fortran environments, including
lists of datatypes and flags,
Fortran utility functions,
user notes,
and new features made possible by leveraging the Fortran 2003 standard.
</dir>
<p>
<strong>C++ API</strong>
<dir>
<!--
<a href="../cpplus/CppUserNotes.pdf">
<cite>HDF5 C++ User’s Notes</cite></a>
<p>
-->
<a href="../cpplus_RM/index.html">
<cite>HDF5 C++ Reference Manual</cite></a>
provides a complete reference for the HDF5 C++ interface.
<!--
<p>
<a href="../cpplus/CppInterfaces.html" target="External">
<cite>HDF5 C++ Interfaces</cite></a>
-->
<p>
</dir>
<br><br>
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" -->
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="../index.html">HDF5 documents and links</a> <br>
<a href="../H5.intro.html">Introduction to HDF5</a> <br>
<a href="../UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
In the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<font size="-1"><br>
<a href="../HL/RM_H5DS.html">H5DS</a>
<a href="../HL/RM_H5IM.html">H5IM</a>
<a href="../HL/RM_H5LT.html">H5LT</a>
<a href="../HL/RM_H5PT.html">H5PT</a>
<a href="../HL/RM_H5TB.html">H5TB</a>
<a href="../HL/RM_HDF5Optimized.html">Optimized</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<br>
<a href="RM_H5L.html">H5L</a>
<a href="RM_H5O.html">H5O</a>
<a href="RM_H5P.html">H5P</a>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<br>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
<a href="../fortran/index.html">Fortran</a>
<a href="APICompatMacros.html">Compatibility Macros</a>
<br>
<a href="CollectiveCalls.html">Collective Calls in Parallel</a>
</font>
<!--
<br>
<i><font size=-1>(Printable <a href="http://hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF">PDF</a> of this Reference Manual)</font></i>
-->
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" -->
<address>
<table width="100%" border="0">
<tr valign="top">
<td align="left">
<address>
The HDF Group Help Desk: <img src="../Graphics/help.png" align=top height=16>
<br>
Describes HDF5 Release 1.8.13, May 2014.
</address>
</td><td width="5%"> </td>
<td align="right">
<a href="../Copyright.html">Copyright</a> by
<a href="http://www.hdfgroup.org">The HDF Group</a>
<br>
and the Board of Trustees of the University of Illinois
</td>
</tr>
</table>
</address>
<!-- #EndLibraryItem --><table width="100%" border="0"> <tr valign="top"> <td align="left">
<SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 14 May 2014");
-->
</SCRIPT>
</td></tr></table>
</body>
</html>
|
