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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
|
<html>
<head><title>
HDF5/Tools API Specification
</title></head>
<body bgcolor="#FFFFFF">
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="H5.user.html">HDF5 User Guide</a> <br>
<a href="index.html">Other HDF5 documents and links</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</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>
<a href="RM_H5P.html">H5P</a>
<br>
<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>
Tools
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr>
<center>
<h1>HDF5 Tools</h1>
</center>
<h2>HDF5 Tool Interfaces</h2>
<p>
These tools enable the user to examine HDF5 file contents,
to modify HDF5 file contents in a carefully prescribed manner, and
to convert files from HDF4 format to HDF5 format and vice versa.
<table border=0>
<tr><td valign=top>
<ul>
<li><a href="#Tools-Dump">h5dump</a> --
A tool for displaying HDF5 file contents
<li><a href="#Tools-Ls">h5ls</a> --
A tool for listing specified features of HDF5 file contents
<li><a href="#Tools-Repart">h5repart</a> --
A tool for repartitioning a file, creating a family of files
<li><a href="#Tools-GIF2H5">gif2h5</a> --
A tool for converting a GIF file to an HDF5 file
<li><a href="#Tools-H52GIF">h52gif</a> --
A tool for converting images in an HDF5 file to a GIF file
<li><a href="#Tools-H5toh4">h5toh4</a> --
A tool for converting an HDF5 file to an HDF4 file
<li><a href="#Tools-H4toh5">h4toh5</a> --
A tool for converting an HDF4 file to an HDF5 file
<li><a href="http://hdf.ncsa.uiuc.edu/java-hdf5-html/">Java-based tools for HDF5</a> --
<em>(at <code>http://hdf.ncsa.uiuc.edu/java-hdf5-html/</code>)</em>
<br>
Java-based tools for viewing, manipulating, and generating HDF5 files
(distributed separately)
<br>
Includes <code>H5view</code>, <code>H5gen</code>,
Java HDF5 Interface (JHI5), and HDF5 VisAD Data Adapter
</ul>
</td></tr>
</table>
<p>
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-Dump">h5dump</a>
<dt><strong>Syntax:</strong>
<dd><code>h5dump
[</code><em>OPTIONS</em><code>]</code> <em>file</em>
<dt><strong>Purpose:</strong>
<dd>Displays HDF5 file contents.
<dt><strong>Description:</strong>
<dd><code>h5dump</code> enables the user to examine
the contents of an HDF5 file and dump those contents, in human
readable form, to an ASCII file.
<p>
<code>h5dump</code> dumps HDF5 file content to standard output.
It can display the contents of the entire HDF5 file or
selected objects, which can be groups, datasets, a subset of a
dataset, links, attributes, or datatypes.
</p>
<p>
The <code>--header</code> option displays object header
information only.
</p>
<p>
Names are the absolute names of the objects. <code>h5dump</code>
displays objects in the order same as the command order. If a
name does not start with a slash, <code>h5dump</code> begins
searching for the specified object starting at the root group.
</p>
<p>
If an object is hard linked with multiple names,
<code>h5dump</code> displays the content of the object in the
first occurrence. Only the link information is displayed in later
occurrences.
</p>
<p>
<code>h5dump</code> assigns a name for any unnamed datatype in
the form of
<code>#</code><em>oid1</em><code>:</code><em>oid2</em>, where
<em>oid1</em> and <em>oid2</em> are the object identifiers
assigned by the library. The unnamed types are displayed within
the root group.
</p>
<p>
Datatypes are displayed with standard type names. For example,
if a dataset is created with <code>H5T_NATIVE_INT</code> type
and the standard type name for integer on that machine is
<code>H5T_STD_I32BE</code>, <code>h5dump</code> displays
<code>H5T_STD_I32BE</code> as the type of the dataset.
</p>
<p>
<code>h5dump</code> can also dump a subset of a dataset.
This feature operates in much the same way as hyperslabs in HDF5;
the parameters specified on the commnd line are passed to the
function <a href="RM_H5S.html#Dataspace-SelectHyperslab">
<code>H5Sselect_hyperslab</code></a> and the resulting selection
is displayed.
</p>
<p>
The <code>h5dump</code> output is described in detail in the
<a href="ddl.html"><cite>DDL for HDF5</cite></a>, the
<cite>Data Description Language</cite> document.
</p>
<p>
<em>Note</em>: It is not permissable to specify multiple
attributes, datasets, datatypes, groups, or soft links with one
flag. For example, one may not issue the command
<br>
<font size=-1>WRONG:</font>
<code>h5dump -a /attr1 /attr2 foo.h5</code>
</br>
to display both <code>/attr1</code> and <code>/attr2</code>.
One must issue the following command:
<br>
<font size=-1>CORRECT:</font>
<code>h5dump -a /attr1 -a /attr2 foo.h5</code>
</br>
<dt><strong>XML Output:</strong>
<dd>With the <code>--xml</code> option, <code>h5dump</code> generates
XML output. This output contains a complete description of the file,
marked up in XML. The XML conforms to the HDF5 Document Type
Definition (DTD) available at
<a href="http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd">
<code>http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd</code></a>.
<p>
The XML output is suitable for use with other tools, including the
<a href="http://hdf.ncsa.uiuc.edu/java-hdf5-html">HDF5 Java Tools</a>.
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-h</code> or
<code>--help</code></dt>
<dd>Print a usage message and exit.</dd>
<dt><code>-B</code> or
<code>--bootblock</code></dt>
<dd>Print the content of the boot block.<br>
<em>(This option is not yet implemented.)</em></dd>
<dt><code>-H</code> or
<code>--header</code></dt>
<dd>Print the header only; no data is displayed.</dd>
<dt><code>-i</code> or
<code>--object-ids</code></dt>
<dd>Print the object ids.</dd>
<dt><code>-V</code> or
<code>--version</code></dt>
<dd>Print version number and exit.</dd>
<dt><code>-a <em>P</em></code> or
<code>--attribute=<em>P</em></code></dt>
<dd>Print the specified attribute.</dd>
<dt><code>-d <em>P</em></code> or
<code>--dataset=<em>P</em></code></dt>
<dd>Print the specified dataset.</dd>
<dt><code>-g <em>P</em></code> or
<code>--group=<em>P</em></code></dt>
<dd>Print the specified group and all members.</dd>
<dt><code>-l <em>P</em></code> or
<code>--soft-link=<em>P</em></code></dt>
<dd>Print the value(s) of the specified soft link.</dd>
<dt><code>-o <em>F</em></code> or
<code>--output=<em>F</em></code></dt>
<dd>Output raw data into file F.</dd>
<dt><code>-t <em>T</em></code> or
<code>--datatype=<em>T</em></code></dt>
<dd>Print the specified named datatype.</dd>
<dt><code>-w <em>N</em></code> or
<code>--width=<em>N</em></code></dt>
<dd>Set the number of columns of output.</dd>
<dt><code>-x <em>U</em></code> or
<code>--xml</code></dt>
<dd>Output XML instead of DDL.</dd>
<dt><code>-D <em>U</em></code> or
<code>--xml-dtd=<em>U</em></code></dt>
<dd>In XML output, refer to the DTD at <em>U</em>
instead of the default DTD.</dd>
<dt><code>-s <em>L</em></code> or
<code>--start=<em>L</em></code></dt>
<dd>Offset of start of subsetting selection.
<br>
Default: the beginning of the dataset.</dd>
<dt><code>-S <em>L</em></code> or
<code>--stride=<em>L</em></code></dt>
<dd>Hyperslab stride.
<br>
Default: 1 in all dimensions.</dd>
<dt><code>-c <em>L</em></code> or
<code>--count=<em>L</em></code></dt>
<dd>Number of blocks to include in the selection.</dd>
<dt><code>-k <em>L</em></code> or
<code>--block=<em>L</em></code></dt>
<dd>Size of block in hyperslab.
<br>
Default: 1 in all dimensions.</dd>
<dt><em>file</em></dt>
<dd>The file to be examined.</dd>
<br><br>
<dt>The option parameters listed above are defined as follows:
<dd><em>P</em> -- The full path from the root group to
the object</dd>
<dd><em>T</em> -- The name of the datatype</dd>
<dd><em>F</em> -- A filename</dd>
<dd><em>N</em> -- An integer greater than 1</dd>
<dd><em>L</em> -- A list of integers, the number of which is
equal to the number of dimensions in the dataspace being
queried</dd>
<dd><em>U</em> -- A URI (as defined in
[<a href="http://www.ietf.org/rfc/rfc2396.txt">IETF RFC 2396</a>],
updated by
[<a href="http://www.ietf.org/rfc/rfc2732.txt">IETF RFC 2732</a>])
that refers to the DTD to be used to validate the XML</dd>
<br><br>
<dt>Subsetting paramaters can also be expressed in a convenient
compact form, as follows:
<br>
<code>--dataset="/foo/mydataset[START;STRIDE;COUNT;BLOCK]"</code>
<br>
All of the semicolons (<code>;</code>) are required, even when
a parameter value is not specified.
When not specified, default parameter values are used.
</dl>
<p>
<dt><strong>Examples:</strong>
<ol>
<li>Dumping the group <code>/GroupFoo/GroupBar</code> in the file
<code>quux.h5</code>:
<blockquote>
<code>h5dump -g /GroupFoo/GroupBar quux.h5</code>
</blockquote>
<li>Dumping the dataset <code>Fnord</code> in the group
<code>/GroupFoo/GroupBar</code> in the file <code>quux.h5</code>:
<blockquote>
<code>h5dump -d /GroupFoo/GroupBar/Fnord quux.h5</code>
</blockquote>
<li>Dumping the attribute <code>metadata</code> of the dataset
<code>Fnord</code> which is in group
<code>/GroupFoo/GroupBar</code> in the file <code>quux.h5</code>:
<blockquote>
<code>h5dump -a /GroupFoo/GroupBar/Fnord/metadata quux.h5</code>
</blockquote>
<li>Dumping the attribute <code>metadata</code> which is an
attribute of the root group in the file <code>quux.h5</code>:
<blockquote>
<code>h5dump -a /metadata quux.h5</code>
</blockquote>
<li>Producing an XML listing of the file <code>bobo.h5</code>:
<blockquote>
<code>h5dump --xml bobo.h5 > bobo.h5.xml</code>
</blockquote>
<li>Dumping a subset of the dataset <code>/GroupFoo/databar/</code>
in the file <code>quux.h5</code>
<blockquote>
<code>h5dump -d /GroupFoo/databar --start="1,1" --stride="2,3"
<br>
--count="3,19" --block="1,1" quux.h5</code>
</blockquote>
<li>The same example using the short form to specify the
subsetting parameters:
<blockquote>
<code>h5dump -d "/GroupFoo/databar[1,1;2,3;3,19;1,1]" quux.h5</code>
</blockquote>
</ol>
<dt><strong>Current Status:</strong>
<dd>The current version of <code>h5dump</code> displays the
following information:
<ul>
<li>Group
<ul>
<li>group attribute (see Attribute)
<li>group member
</ul>
<li>Dataset
<ul>
<li>dataset attribute (see Attribute)
<li>dataset type (see Datatype)
<li>dataset space (see Dataspace)
<li>dataset data
</ul>
<li>Attribute
<ul>
<li>attribute type (see Datatype)
<li>attribute space (see Dataspace)
<li>attribute data
</ul>
<li>Datatype
<ul>
<li>integer type
<br>
- H5T_STD_I8BE, H5T_STD_I8LE, H5T_STD_I16BE, ...
<li>floating point type
<br>
- H5T_IEEE_F32BE, H5T_IEEE_F32LE, H5T_IEEE_F64BE, ...
<li>string type
<li>compound type
<br>
- named, unnamed and transient compound type
<br>
- integer, floating or string type member
<li>opaque types
<li>reference type
<br>
- object references
<br>
- data regions
<li>enum type
<li>variable-length datatypes
<br>
- atomic types only
<br>
- scalar or single dimensional array of variable-length
types supported
</ul>
<li>Dataspace
<ul>
<li>scalar and simple space
</ul>
<li>Soft link
<li>Hard link
<li>Loop detection
</ul>
<dt><strong>See Also:</strong>
<ul>
<li>HDF5 Data Description Language syntax at
<a href="ddl.html"><cite>DDL for HDF5</cite></a>
<li>HDF5 XML DTD at
<a href="http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd">http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd</a>
<li>HDF5 XML information at
<a href="http://hdf.ncsa.uiuc.edu/HDF5/XML">http://hdf.ncsa.uiuc.edu/HDF5/XML/</a>
</ul>
</dl>
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-Ls">h5ls</a>
<dt><strong>Syntax:</strong>
<dd><code>h5ls
[</code><em>OPTIONS</em><code>]</code><em>
file</em><code>
[</code><em>OBJECTS...</em><code>]</code>
<dt><strong>Purpose:</strong>
<dd>Prints information about a file or dataset.
<dt><strong>Description:</strong>
<dd><code>h5ls</code> prints selected information about file objects
in the specified format.
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-h</code> or
<code>-?</code> or
<code>--help</code>
<dd>Print a usage message and exit.
<dt><code>-a</code> or
<code>--address</code>
<dd>Print addresses for raw data.
<dt><code>-d</code> or <code>--data</code>
<dd>Print the values of datasets.
<dt><code>-e</code> or
<code>--errors</code>
<dd>Show all HDF5 error reporting.
<dt><code>-f</code> or
<code>--full</code>
<dd>Print full path names instead of base names.
<dt><code>-g</code> or
<code>--group</code>
<dd>Show information about a group, not its contents.
<dt><code>-l</code> or
<code>--label</code>
<dd>Label members of compound datasets.
<dt><code>-r</code> or
<code>--recursive</code>
<dd>List all groups recursively, avoiding cycles.
<dt><code>-s</code> or
<code>--string</code>
<dd>Print 1-bytes integer datasets as ASCII.
<dt><code>-S</code> or
<code>--simple</code>
<dd>Use a machine-readable output format.
<dt><code>-w</code><em>N</em> or
<code>--width=</code><em>N</em>
<dd>Set the number of columns of output.
<dt><code>-v</code> or
<code>--verbose</code>
<dd>Generate more verbose output.
<dt><code>-V</code> or
<code>--version</code>
<dd>Print version number and exit.
<dt><code>-x</code> or
<code>--hexdump</code>
<dd>Show raw data in hexadecimal format.
<dt><em>file</em>
<dd>The file name may include a printf(3C) integer format
such as <code>%%05d</code> to open a file family.
<dt><em>objects</em>
<dd>Each object consists of an HDF5 file name optionally
followed by a slash and an object name within the file
(if no object is specified within the file then the
contents of the root group are displayed). The file name
may include a <code>printf(3C)</code> integer format such
as "%05d" to open a file family.
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
-->
</dl>
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-Repart">h5repart</a>
<dt><strong>Syntax:</strong>
<dd><code>h5repart
[-v]
[-V]
[-[b|m]</code><em>N</em><code>[g|m|k]]</code>
<em>source_file
dest_file</em>
<dt><strong>Purpose:</strong>
<dd>Repartitions a file or family of files.
<dt><strong>Description:</strong>
<dd><code>h5repart</code> splits a single file into a family of
files, joins a family of files into a single file, or copies
one family of files to another while changing the size of the
family members. <code>h5repart</code> can also be used to
copy a single file to a single file with holes.
<p>
Sizes associated with the <code>-b</code> and <code>-m</code>
options may be suffixed with <code>g</code> for gigabytes,
<code>m</code> for megabytes, or <code>k</code> for kilobytes.
<p>
File family names include an integer <code>printf</code>
format such as <code>%d</code>.
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-v</code>
<dd>Produce verbose output.
<dt><code>-V</code>
<dd>Print a version number and exit.
<dt><code>-b</code><em>N</em>
<dd>The I/O block size, defaults to 1kB
<dt><code>-m</code><em>N</em>
<dd>The destination member size or 1GB
<dt><em>source_file</em>
<dd>The name of the source file
<dt><em>dest_file</em>
<dd>The name of the destination files
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
-->
</dl>
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-GIF2H5">gif2h5</a>
<dt><strong>Syntax:</strong>
<dd><code>gif2h5</code>
<em>gif_file</em> <em>h5_file</em>
<dt><strong>Purpose:</strong>
<dd>Converts a GIF file to an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>gif2h5</code> accepts as input the GIF file <em>gif_file</em>
and produces the HDF5 file <em>h5_file</em> as output.
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><em>gif_file</em>
<dd>The name of the input GIF file
<dt><em>h5_file</em>
<dd>The name of the output HDF5 file
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
-->
</dl>
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-H52GIF">h52gif</a>
<dt><strong>Syntax:</strong>
<dd><code>h52gif</code>
<em>h5_file</em> <em>gif_file</em>
<code>-i</code> <em>h5_image</em>
<code>[-p</code> <em>h5_palette</em><code>]</code>
<dt><strong>Purpose:</strong>
<dd>Converts an HDF5 file to a GIF file.
<dt><strong>Description:</strong>
<dd><code>h52gif</code> accepts as input the HDF5 file <em>h5_file</em>
and the names of images and associated palettes within that file
as input and produces the GIF file <em>gif_file</em>,
containing those images, as output.
<p>
<code>h52gif</code> expects <em>at least</em>
one <em>h5_image</em>.
You may repeat
<br>
<code>-i</code> <em>h5_image</em>
<code>[-p</code> <em>h5_palette</em><code>]</code>
<br>
up to 50 times, for a maximum of 50 images.
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><em>h5_file</em>
<dd>The name of the input HDF5 file
<dt><em>gif_file</em>
<dd>The name of the output GIF file
<dt><code>-i</code> <em>h5_image</em>
<dd>Image option, specifying the name of an HDF5 image or
dataset containing an image to be converted
<dt><code>-p</code> <em>h5_palette</em>
<dd>Palette option, specifying the name of an HDF5 dataset
containing a palette to be used in an image conversion
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
-->
</dl>
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-H5toh4">h5toh4</a>
<dt><strong>Syntax:</strong>
<dd><code>h5toh4 -h</code><br>
<code>h5toh4 </code><em>
h5file
h4file</em><br>
<code>h5toh4 </code><em>
h5file</em><br>
<code>h5toh4 -m </code><em>
h5file1
h5file2
h5file3</em> ...
<dt><strong>Purpose:</strong>
<dd>Converts an HDF5 file into an HDF4 file.
<dt><strong>Description:</strong>
<dd><code>h5toh4</code> is an HDF5 utility which reads
an HDF5 file, <em>h5file</em>, and converts all
supported objects and pathways to produce an HDF4 file,
<em>h4file</em>. If <em>h4file</em> already exists,
it will be replaced.
<p>
If only one file name is given, the name must end in
<code>.h5</code> and is assumed to represent the
HDF5 input file. <code>h5toh4</code> replaces the
<code>.h5</code> suffix with <code>.hdf</code> to form
the name of the resulting HDF4 file and proceeds as above.
If a file with the name of the intended HDF4 file already
exists, <code>h5toh4</code> exits with an error without
changing the contents of any file.
<p>
The <code>-m</code> option allows multiple HDF5 file
arguments. Each file name is treated the same as the
single file name case above.
<p>
The <code>-h</code> option causes the following
syntax summary to be displayed:
<pre> h5toh4 file.h5 file.hdf
h5toh4 file.h5
h5toh4 -m file1.h5 file2.h5 ...</pre>
<p>
The following HDF5 objects occurring in an HDF5 file are
converted to HDF4 objects in the HDF4 file:
<ul>
<li>HDF5 group objects are converted into HDF4 Vgroup
objects. HDF5 hardlinks and softlinks pointing to
objects are converted to HDF4 Vgroup references.
<li>HDF5 dataset objects of integer datatype are
converted into HDF4 SDS objects. These datasets
may have up to 32 fixed dimensions.
The slowest varying dimension may be extendable.
8-bit, 16-bit, and 32-bit integer datatypes are
supported.
<li>HDF5 dataset objects of floating point datatype
are converted into HDF4 SDS objects.
These datasets may have up to 32 fixed dimensions.
The slowest varying dimension may be extendable.
32-bit and 64-bit floating point datatypes are
supported.
<li>HDF5 dataset objects of single dimension and
compound datatype are converted into HDF4 Vdata
objects. The length of that single dimension may
be fixed or extendable. The members of the
compound datatype are constrained to be no more
than rank 4.
<li>HDF5 dataset objects of single dimension and fixed length string
datatype are converted into HDF4 Vdata objects. The HDF4 Vdata
is a single field whose order is the length of the HDF5 string
type. The number of records of the Vdata is the length of the
single dimension which may be fixed or extendable.
</ul>
Other objects are not converted and are not recorded
in the resulting <em>h4file</em>.
<p>
Attributes associated with any of the supported HDF5
objects are carried over to the HDF4 objects.
Attributes may be of integer, floating point, or fixed length
string datatype and they may have up to 32 fixed dimensions.
<p>
All datatypes are converted to big-endian.
Floating point datatypes are converted to IEEE format.
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-h</code>
<dd>Displays a syntax summary.
<dt><code>-m</code>
<dd>Converts multiple HDF5 files to multiple HDF4 files.
<dt><em>h5file</em>
<dd>The HDF5 file to be converted.
<dt><em>h4file</em>
<dd>The HDF4 file to be created.
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
-->
</dl>
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-H4toh5">h4toh5</a>
<dt><strong>Syntax:</strong>
<dd><code>h4toh5 -h</code><br>
<code>h4toh5 </code><em>
h4file
h5file</em><br>
<code>h4toh5 </code><em>
h4file</em><br>
<!-- currently no -m option
<code>h4toh5 -m </code><em>
h4file1
h4file2
h4file3</em> ...
-->
<dt><strong>Purpose:</strong>
<dd>Converts an HDF4 file to an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>h4toh5</code> is a file conversion utility that reads
an HDF4 file, <em>h4file</em> (<code>input.hdf</code> for example),
and writes an HDF5 file, <em>h5file</em> (<code>output.h5</code>
for example), containing the same data.
<p>
If no output file <em>h5file</em> is specified,
<code>h4toh5</code> uses the input filename to designate
the output file, replacing the extension <code>.hdf</code>
with <code>.h5</code>.
For example, if the input file <code>scheme3.hdf</code> is
specified with no output filename, <code>h4toh5</code> will
name the output file <code>scheme3.h5</code>.
<p>
<!-- currently no -m option
The <code>-m</code> option allows multiple HDF5 file
arguments. Each file name is treated the same as the
single file name case above.
<p>
-->
The <code>-h</code> option causes a syntax summary
similar to the following to be displayed:
<pre> h4toh5 inputfile.hdf outputfile.h5
h5toh4 inputfile.hdf <!-- currently no -m option
h5toh4 -m inputfile1.hdf inputfile2.hdf ... --> </pre>
<p>
Each object in the HDF4 file is converted to an equivalent
HDF5 object, according to the mapping described in
<a href="ADGuide/H4toH5Mapping.pdf" target=ExternalWinA>
<cite>Mapping HDF4 Objects to HDF5 Objects</cite></a>.
(If this mapping changes between HDF5 Library releases, a more up-to-date
version may be available at
<a href="http://hdf.ncsa.uiuc.edu/HDF5/papers/h4toh5/H4-to-H5MappingGuidelines.pdf" target=ExternalWinB>
<cite>Mapping HDF4 Objects to HDF5 Objects</cite> on the HDF FTP server</a>.)
<p>
In this inital version, <code>h4toh5</code> converts the following
HDF4 objects:
<center>
<table width=75% border=0>
<tr><th width=40% valign=top align=left>
HDF4 Object
</td><th width=60% valign=top align=left>
Resulting HDF5 Object
</td></tr>
<tr><td width=40% valign=top align=left>
SDS
</td><td width=60% valign=top align=left>
Dataset
</td></tr>
<tr><td width=40% valign=top align=left>
GR, RI8, and RI24 image
</td><td width=60% valign=top align=left>
Dataset
</td></tr>
<tr><td width=40% valign=top align=left>
Vdata
</td><td width=60% valign=top align=left>
Dataset
</td></tr>
<tr><td width=40% valign=top align=left>
Vgroup
</td><td width=60% valign=top align=left>
Group
</td></tr>
<tr><td width=40% valign=top align=left>
Annotation
</td><td width=60% valign=top align=left>
Attribute
</td></tr>
<tr><td width=40% valign=top align=left>
Palette
</td><td width=60% valign=top align=left>
Dataset
</td></tr>
</table>
</center>
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-h</code>
<dd>Displays a syntax summary.
<!-- currently no -m option
<dt><code>-m</code>
<dd>Converts multiple HDF4 files to multiple HDF5 files.
-->
<dt><em>h4file</em>
<dd>The HDF4 file to be converted.
<dt><em>h5file</em>
<dd>The HDF5 file to be created.
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
-->
</dl>
<!-- Template, next 40 lines -->
<!-- Template, next 40 lines -->
<!-- Template, next 40 lines
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-H5toh4">h5toh4</a>
<dt><strong>Syntax:</strong>
<dd><code>h5toh4 -h</code><br>
<code>h5toh4 </code><em>
h5file
h4file</em><br>
<code>h5toh4 </code><em>
h5file</em><br>
<code>h5toh4 -m </code><em>
h5file1
h5file2
h5file3</em> ...
<dt><strong>Purpose:</strong>
<dd>Purpose...
<dt><strong>Description:</strong>
<dd><code>TOOL</code> is an HDF5 utility which ...
Paragraph
<pre> sample code
sample code
sample code </pre>
<p>
Paragraph
<p>
Paragraph
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-option</code>
<dd>Description
<dt><em>parameter</em>
<dd>Description
</dl>
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
</dl>
-->
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="H5.user.html">HDF5 User Guide</a> <br>
<a href="index.html">Other HDF5 documents and links</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</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>
<a href="RM_H5P.html">H5P</a>
<br>
<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>
Tools
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 2 August 2001
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch
</body>
</html>
|
