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
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
|
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.61 [en] (WinNT; I) [Netscape]">
<title>HDF5/Tools API Specification
</title>
</head>
<body bgcolor="#FFFFFF">
<hr>
<center>
<table border="0" width="98%">
<tr>
<td align=left valign=top>
<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 align=right valign=top>
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>
These tools enable the user to examine HDF5 files interactively.
<table BORDER=0 >
<tr>
<td VALIGN=TOP>
<ul>
<li><a href="#Tools-Dump">h5dump</a> -- A tool for displaying
HDF5 file contents</li>
<li><a href="#Tools-Ls">h5ls</a> -- A tool for listing specified
features of HDF5 file contents</li>
<li><a href="#Tools-Repart">h5repart</a> -- A tool for
repartitioning a file, creating a family of files</li>
<li><a href="#Tools-H5toh4">h5toh4</a> -- A tool for converting
an HDF5 file to an HDF4 file</li>
<li><a href="#Tools-H4toh5">h4toh5</a> -- A tool for converting
an HDF4 file to an HDF5 file</li>
</ul>
</td>
</tr>
</table>
<p>
<hr>
<dl>
<dt><b>Tool Name:</b> <a name="Tools-Dump"></a>h5dump</dt>
<dt><b>Syntax:</b></dt>
<dd><tt>h5dump [</tt><i>OPTIONS</i><tt>]</tt> <i>file</i></dd>
<dt><b>Purpose:</b></dt>
<dd>Displays HDF5 file contents in HDF5 DDL or XML.</dd>
<dt><b>Description:</b></dt>
<dd>
<p>
The <tt>h5dump</tt> tool enables the user to interactively examine the
contents of an HDF5 file and dump those contents, in human readable form,
to an ASCII file. Optionally, the contents of the file may be dumped as
XML.
</p>
<p>
<tt>h5dump</tt> dumps an HDF5 file's contents to standard output. It can
display the contents of the whole HDF5 file or selected objects, which
can be groups, datasets, a subset of a dataset, links, attributes, or
data types.
</p>
<p>
The <tt>--header</tt> option displays object header information only.
</p>
<p>
Names are the absolute names of the objects. <tt>h5dump</tt> displays
objects in the same order as given on the command line. If a name does
not start with a slash (/), <tt>h5dump</tt> begins searching for the
specified object starting at the root group.
</p>
<p>
If an object is hard linked with multiple names, <tt>h5dump</tt> displays
the contents of the object in the first occurrence. Only the link
information is displayed in later occurrences.
</p>
<p>
<tt>h5dump</tt> assigns a name for any unnamed data type in the form of
<tt>#</tt><i>oid1</i><tt>:</tt><i>oid2</i>, where <i>oid1</i> and
<i>oid2</i> are the object identifiers assigned by the library. The
unnamed types are displayed within the root group.
</p>
<p>
Data types are displayed with standard type names. For example, if a data
set is created with <tt>H5T_NATIVE_INT</tt> type and the standard type
name for integer on that machine is <tt>H5T_STD_I32BE</tt>,
<tt>h5dump</tt> displays <tt>H5T_STD_I32BE</tt> as the type of the data
set.
</p>
<p>
<tt>h5dump</tt> can also be used to dump a subset of data from a dataset.
It operates in much the same way that hyperslabs do in the HDF5 library.
The parameters specified on the command line are passed to the
<a href="RM_H5S.html#Dataspace-SelectHyperslab"><tt>H5Sselect_hyperslab</tt></a>
function and the resulting selection is then displayed.
</p>
<p>
The <tt>h5dump</tt> output is described in detail in the <i><a
href="ddl.html">DDL for HDF5</a></i>, the <i>Data Description
Language</i> document.
</p>
<p>
<i>Note</i>: It is no longer permissable to specify multiple attributes,
datasets, data types, groups, or soft links with one flag. For example,
before one could issue the command:
</p>
<blockquote>
<tt>h5dump -a /attr1 /attr2 foo.h5</tt>
</blockquote>
<p>
and both <tt>/attr1</tt> and <tt>/attr2</tt> would be dumped. In order to
do this now, one must issue the command:
</p>
<blockquote>
<tt>h5dump -a /attr1 -a /attr2 foo.h5</tt>
</blockquote>
<dt><b>XML Output</b></dt>
<p>
The <tt>--xml</tt> option selects output in XML. The XML output contains
a complete description of the file, marked up in XML. The XML conforms to
the HDF5 Document Type Definition (DTD), which is available at:
</p>
<dl><a href="http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd">http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd</a></dl>
<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>.
</p>
<dt><b>Options and Parameters:</b></dt>
<dl>
<dt><tt>-h</tt> or <tt>--help</tt></dt>
<dd>Print a usage message and exit.</dd>
<dt><tt>-B</tt> or <tt>--bootblock</tt></dt>
<dd>Print the content of the boot block.<br>
<i>(This option is not yet implemented.)</i></dd>
<dt><tt>-H</tt> or <tt>--header</tt></dt>
<dd>Print the header only; no data is displayed.</dd>
<dt><tt>-i</tt> or <tt>--object-ids</tt></dt>
<dd>Print the object ids.</dd>
<dt><tt>-V</tt> or <tt>--version</tt></dt>
<dd>Print version number and exit.</dd>
<dt><tt>-a <i>P</i></tt> or <tt>--attribute=<i>P</i></tt></dt>
<dd>Print the specified attribute.</dd>
<dt><tt>-d <i>P</i></tt> or <tt>--dataset=<i>P</i></tt></dt>
<dd>Print the specified dataset.</dd>
<dt><tt>-g <i>P</i></tt> or <tt>--group=<i>P</i></tt></dt>
<dd>Print the specified group and all members.</dd>
<dt><tt>-l <i>P</i></tt> or <tt>--soft-link=<i>P</i></tt></dt>
<dd>Print the value(s) of the specified soft link.</dd>
<dt><tt>-o <i>F</i></tt> or <tt>--output=<i>F</i></tt></dt>
<dd>Output raw data into file F.</dd>
<dt><tt>-t <i>T</i></tt> or <tt>--datatype=<i>T</i></tt></dt>
<dd>Print the specified named data type.</dd>
<dt><tt>-w <i>N</i></tt> or <tt>--width=<i>N</i></tt></dt>
<dd>Set the number of columns of output.</dd>
<dt><tt>-x <i>U</i></tt> or <tt>--xml</tt></dt>
<dd>Output XML instead of DDL.</dd>
<dt><tt>-D <i>U</i></tt> or <tt>--xml-dtd=<i>U</i></tt></dt>
<dd>In XML output, refer to the DTD at U instead of the default DTD.</dd>
<dt><tt>-s <i>L</i></tt> or <tt>--start=<i>L</i></tt></dt>
<dd>Offset of start of subsetting selection [Default: beginning of
dataset]</dd>
<dt><tt>-S <i>L</i></tt> or <tt>--stride=<i>L</i></tt></dt>
<dd>Hyperslab stride [Default: 1 in all dimensions]</dd>
<dt><tt>-c <i>L</i></tt> or <tt>--count=<i>L</i></tt></dt>
<dd>Number of blocks to include in selection</dd>
<dt><tt>-k <i>L</i></tt> or <tt>--block=<i>L</i></tt></dt>
<dd>Size of block in hyperslab [Default: 1 in all dimensions]</dd>
<dt><i>file</i></dt>
<dd>The file to be examined.</dd>
</dl>
<ul>
<li><i>P</i> - is the full path from the root group to the object.</li>
<li><i>T</i> - is the name of the data type.</li>
<li><i>F</i> - is a filename.</li>
<li><i>N</i> - is an integer greater than 1.</li>
<li><i>L</i> - is a list of integers the number of which are equal to
the number of dimensions in the dataspace being queried.</li>
<li><i>U</i> - is 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.</li>
</ul>
<p>
Subsetting parameters can be specified in a convenient compact format.
The format is:
</p>
<blockquote>
<tt>--dataset="/foo/mydataset[START;STRIDE;COUNT;BLOCK]"</tt>
</blockquote>
<p>
All of the semicolons (;) are required to be there even if you don't
specify a value for the parameter (thereby using the default value).
</p>
<dt><b>Examples:</b></dt>
<ol>
<li>Dumping the group <tt>/GroupFoo/GroupBar</tt> in the file
<tt>quux.h5</tt>:</li>
<blockquote>
<tt>h5dump -g /GroupFoo/GroupBar quux.h5</tt>
</blockquote>
<li>Dumping the dataset <tt>Fnord</tt> in the group
<tt>/GroupFoo/GroupBar</tt> in the file <tt>quux.h5</tt>:</li>
<blockquote>
<tt>h5dump -d /GroupFoo/GroupBar/Fnord quux.h5</tt>
</blockquote>
<li>Dumping the attribute <tt>metadata</tt> of the dataset
<tt>Fnord</tt> which is in group <tt>/GroupFoo/GroupBar</tt> in
the file <tt>quux.h5</tt>:</li>
<blockquote>
<tt>h5dump -a /GroupFoo/GroupBar/Fnord/metadata quux.h5</tt>
</blockquote>
<li>Dumping the attribute <tt>metadata</tt> which is an attribute
of the root group in the file <tt>quux.h5</tt>:</li>
<blockquote>
<tt>h5dump -a /metadata quux.h5</tt>
</blockquote>
<li>Producing an XML listing of the file bobo.h5:</li>
<blockquote>
<tt>h5dump --xml bobo.h5 > bobo.h5.xml</tt>
</blockquote>
<li>Dumping a subset of the dataset <tt>/GroupFoo/databar</tt> in
file <tt>quux.h5</tt>:</li>
<blockquote>
<tt>h5dump -d /GroupFoo/databar --start="1,1" --stride="2,3" --count="3,19" --block="1,1" quux.h5</tt>
</blockquote>
<li>The same example using the short form of specifying the
subsetting parameters:</li>
<blockquote>
<tt>h5dump -d "/GroupFoo/databar[1,1;2,3;3,19;1,1]" quux.h5</tt>
</blockquote>
</ol>
<dt><b>Current Status:</b></dt>
<dd>The current version of <tt>h5dump</tt> displays the following
information:</dd>
<ul>
<li>Group</li>
<ul>
<li>group attribute (see Attribute)</li>
<li>group member</li>
</ul>
<li>Dataset</li>
<ul>
<li>dataset attribute (see Attribute)</li>
<li>dataset type (see Data type)</li>
<li>dataset space (see Data space)</li>
<li>dataset data</li>
</ul>
<li>Attribute</li>
<ul>
<li>attribute type (see Data type)</li>
<li>attribute space (see Data space)</li>
<li>attribute data</li>
</ul>
<li>Data type</li>
<ul>
<li>integer type</li>
<dt>- <tt>H5T_STD_I8BE, H5T_STD_I8LE, H5T_STD_I16BE, ...</tt></dt>
<li>floating point type</li>
<dt>- <tt>H5T_IEEE_F32BE, H5T_IEEE_F32LE, H5T_IEEE_F64BE, ...</tt></dt>
<li>string type</li>
<li>compound type</li>
<dt>- named, unnamed and transient compound type</dt>
<dt>- integer, floating or string type member</dt>
<li>opaque types</li>
<li>reference type</li>
<dt>- object references</dt>
<dt>- data regions</dt>
<li>enum type</li>
<li>variable-length datatypes</li>
<dt>- atomic types only</dt>
<dt>- scalar or single dimensional array of variable-length types
supported</dt>
</ul>
<li>Data space</li>
<ul>
<li>scalar and simple space</li>
</ul>
<li>Soft link</li>
<li>Hard link</li>
<li>Loop detection</li>
</ul>
<dt><b>See Also:</b></dt>
<dd>HDF5 Data Description Language syntax (<i><a href="ddl.html">DDL
for HDF5</a></i>)</dd>
<dd>HDF5 XML DTD: <a
href="http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd">http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd</a></dd>
<dd>HDF5 XML information: <a
href="http://hdf.ncsa.uiuc.edu/HDF5/XML">http://hdf.ncsa.uiuc.edu/HDF5/XML</a>/</dd>
</dt>
</dl>
<hr>
<dl>
<dt>
<b>Tool Name:</b> <a NAME="Tools-Ls"></a>h5ls</dt>
<dt>
<b>Syntax:</b></dt>
<dd>
<tt>h5ls [</tt><i>OPTIONS</i><tt>]</tt><i> file</i><tt> [</tt><i>OBJECTS...</i><tt>]</tt></dd>
<dt>
<b>Purpose:</b></dt>
<dd>
Prints information about a file or dataset.</dd>
<dt>
<b>Description:</b></dt>
<dd>
<tt>h5ls</tt> prints selected information about file objects in the specified
format.</dd>
<dt>
<b>Options and Parameters:</b></dt>
<dl>
<dt>
<tt>-h</tt> or <tt>-?</tt> or
<tt>--help</tt></dt>
<dd>
Print a usage message and exit.</dd>
<dt>
<tt>-a</tt> or <tt>--address</tt></dt>
<dd>
Print addresses for raw data.</dd>
<dt>
<tt>-d</tt> or <tt>--data</tt></dt>
<dd>
Print the values of datasets.</dd>
<dt>
<tt>-e</tt> or <tt>--errors</tt></dt>
<dd>
Show all HDF5 error reporting.</dd>
<dt>
<tt>-f</tt> or <tt>--full</tt></dt>
<dd>
Print full path names instead of base names.</dd>
<dt>
<tt>-g</tt> or <tt>--group</tt></dt>
<dd>
Show information about a group, not its contents.</dd>
<dt>
<tt>-l</tt> or <tt>--label</tt></dt>
<dd>
Label members of compound datasets.</dd>
<dt>
<tt>-r</tt> or <tt>--recursive</tt></dt>
<dd>
List all groups recursively, avoiding cycles.</dd>
<dt>
<tt>-s</tt> or <tt>--string</tt></dt>
<dd>
Print 1-bytes integer datasets as ASCII.</dd>
<dt>
<tt>-S</tt> or <tt>--simple</tt></dt>
<dd>
Use a machine-readable output format.</dd>
<dt>
<tt>-w</tt><i>N</i> or <tt>--width=</tt><i>N</i></dt>
<dd>
Set the number of columns of output.</dd>
<dt>
<tt>-v</tt> or <tt>--verbose</tt></dt>
<dd>
Generate more verbose output.</dd>
<dt>
<tt>-V</tt> or <tt>--version</tt></dt>
<dd>
Print version number and exit.</dd>
<dt>
<tt>-x</tt> or <tt>--hexdump</tt></dt>
<dd>
Show raw data in hexadecimal format.</dd>
<dt>
<i>file</i></dt>
<dd>
The file name may include a printf(3C) integer format such as <tt>%%05d</tt>
to open a file family.</dd>
<dt>
<i>objects</i></dt>
<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 <tt>printf(3C)</tt> integer format such as "%05d" to open
a file family.</dd>
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
--></dl>
<hr>
<dl>
<dt>
<b>Tool Name:</b> <a NAME="Tools-Repart"></a>h5repart</dt>
<dt>
<b>Syntax:</b></dt>
<dd>
<tt>h5repart [-v] [-V] [-[b|m]</tt><i>N</i><tt>[g|m|k]]</tt> <i>source_file
dest_file</i></dd>
<dt>
<b>Purpose:</b></dt>
<dd>
Repartitions a file or family of files.</dd>
<dt>
<b>Description:</b></dt>
<dd>
<tt>h5repart</tt> 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. <tt>h5repart</tt> can also
be used to copy a single file to a single file with holes.</dd>
<br>
<p>
<br>
<br>
<p>Sizes associated with the <tt>-b</tt> and <tt>-m</tt> options may be
suffixed with <tt>g</tt> for gigabytes, <tt>m</tt> for megabytes, or
<tt>k</tt>
for kilobytes.
<p>File family names include an integer <tt>printf</tt> format such as
<tt>%d</tt>.
<dt>
<b>Options and Parameters:</b></dt>
<dl>
<dt>
<tt>-v</tt></dt>
<dd>
Produce verbose output.</dd>
<dt>
<tt>-V</tt></dt>
<dd>
Print a version number and exit.</dd>
<dt>
<tt>-b</tt><i>N</i></dt>
<dd>
The I/O block size, defaults to 1kB</dd>
<dt>
<tt>-m</tt><i>N</i></dt>
<dd>
The destination member size or 1GB</dd>
<dt>
<i>source_file</i></dt>
<dd>
The name of the source file</dd>
<dt>
<i>dest_file</i></dt>
<dd>
The name of the destination files</dd>
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
--></dl>
<hr>
<dl>
<dt>
<b>Tool Name:</b> <a NAME="Tools-H5toh4"></a>h5toh4</dt>
<dt>
<b>Syntax:</b></dt>
<dd>
<tt>h5toh4 -h</tt></dd>
<br><tt>h5toh4 </tt><i>h5file h4file</i>
<br><tt>h5toh4 </tt><i>h5file</i>
<br><tt>h5toh4 -m </tt><i>h5file1 h5file2 h5file3</i> ...
<dt>
<b>Purpose:</b></dt>
<dd>
Converts an HDF5 file into an HDF4 file.</dd>
<dt>
<b>Description:</b></dt>
<dd>
<tt>h5toh4</tt> is an HDF5 utility which reads an HDF5 file, <i>h5file</i>,
and converts all supported objects and pathways to produce an HDF4 file,
<i>h4file</i>.
If <i>h4file</i> already exists, it will be replaced.</dd>
<br>
<p>
<br>
<br>
<p>If only one file name is given, the name must end in <tt>.h5</tt> and
is assumed to represent the HDF5 input file. <tt>h5toh4</tt> replaces the
<tt>.h5</tt>
suffix with <tt>.hdf</tt> 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, <tt>h5toh4</tt> exits with an error without changing the contents
of any file.
<p>The <tt>-m</tt> option allows multiple HDF5 file arguments. Each file
name is treated the same as the single file name case above.
<p>The <tt>-h</tt> 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>
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>
<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>
<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>
<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>
<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.</li>
</ul>
Other objects are not converted and are not recorded in the resulting <i>h4file</i>.
<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>
<b>Options and Parameters:</b></dt>
<dl>
<dt>
<tt>-h</tt></dt>
<dd>
Displays a syntax summary.</dd>
<dt>
<tt>-m</tt></dt>
<dd>
Converts multiple HDF5 files to multiple HDF4 files.</dd>
<dt>
<i>h5file</i></dt>
<dd>
The HDF5 file to be converted.</dd>
<dt>
<i>h4file</i></dt>
<dd>
The HDF4 file to be created.</dd>
</dl>
<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
--></dl>
<hr>
<dl>
<dt>
<b>Tool Name:</b> <a NAME="Tools-H4toh5"></a>h4toh5</dt>
<dt>
<b>Syntax:</b></dt>
<dd>
<tt>h4toh5 -h</tt></dd>
<br><tt>h4toh5 </tt><i>h4file h5file</i>
<br><tt>h4toh5 </tt><i>h4file</i>
<br><!-- currently no -m option
<tt>h4toh5 -m </tt><em>
h4file1
h4file2
h4file3</em> ...
-->
<dt>
<b>Purpose:</b></dt>
<dd>
Converts an HDF4 file to an HDF5 file.</dd>
<dt>
<b>Description:</b></dt>
<dd>
<tt>h4toh5</tt> is a file conversion utility that reads an HDF4 file, <i>h4file</i>
(<tt>input.hdf</tt> for example), and writes an HDF5 file, <i>h5file</i>
(<tt>output.h5</tt> for example), containing the same data.</dd>
<br>
<p>
<br>
<br>
<p>If no output file <i>h5file</i> is specified, <tt>h4toh5</tt> uses the
input filename to designate the output file, replacing the extension
<tt>.hdf</tt>
with <tt>.h5</tt>. For example, if the input file <tt>scheme3.hdf</tt>
is specified with no output filename, <tt>h4toh5</tt> will name the output
file <tt>scheme3.h5</tt>.
<p><!-- currently no -m option
The <tt>-m</tt> option allows multiple HDF5 file
arguments. Each file name is treated the same as the
single file name case above.
<p>
-->The
<tt>-h</tt>
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>
Each object in the HDF4 file is converted to an equivalent HDF5 object,
according to the mapping described in <i><a href="ADGuide/H4toH5Mapping.pdf" target="ExternalWinA">Mapping
HDF4 Objects to HDF5 Objects</a></i>. (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"><i>Mapping
HDF4 Objects to HDF5 Objects</i> on the HDF FTP server</a>.)
<p>In this inital version, <tt>h4toh5</tt> converts the following HDF4
objects:
<center><table BORDER=0 WIDTH="75%" >
<tr>
<th ALIGN=LEFT VALIGN=TOP WIDTH="40%">HDF4 Object </th>
<th ALIGN=LEFT VALIGN=TOP WIDTH="60%">Resulting HDF5 Object </th>
</tr>
<tr>
<td ALIGN=LEFT VALIGN=TOP WIDTH="40%">SDS </td>
<td ALIGN=LEFT VALIGN=TOP WIDTH="60%">Dataset </td>
</tr>
<tr>
<td ALIGN=LEFT VALIGN=TOP WIDTH="40%">GR, RI8, and RI24 image </td>
<td ALIGN=LEFT VALIGN=TOP WIDTH="60%">Dataset </td>
</tr>
<tr>
<td ALIGN=LEFT VALIGN=TOP WIDTH="40%">Vdata </td>
<td ALIGN=LEFT VALIGN=TOP WIDTH="60%">Dataset </td>
</tr>
<tr>
<td ALIGN=LEFT VALIGN=TOP WIDTH="40%">Vgroup </td>
<td ALIGN=LEFT VALIGN=TOP WIDTH="60%">Group </td>
</tr>
<tr>
<td ALIGN=LEFT VALIGN=TOP WIDTH="40%">Annotation </td>
<td ALIGN=LEFT VALIGN=TOP WIDTH="60%">Attribute </td>
</tr>
<tr>
<td ALIGN=LEFT VALIGN=TOP WIDTH="40%">Palette </td>
<td ALIGN=LEFT VALIGN=TOP WIDTH="60%">Dataset </td>
</tr>
</table></center>
<dt>
<b>Options and Parameters:</b></dt>
<dl>
<dt>
<tt>-h</tt></dt>
<dd>
Displays a syntax summary. <!-- currently no -m option
<dt><tt>-m</tt>
<dd>Converts multiple HDF4 files to multiple HDF5 files.
--></dd>
<dt>
<i>h4file</i></dt>
<dd>
The HDF4 file to be converted.</dd>
<dt>
<i>h5file</i></dt>
<dd>
The HDF5 file to be created.</dd>
</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><tt>h5toh4 -h</tt><br>
<tt>h5toh4 </tt><em>
h5file
h4file</em><br>
<tt>h5toh4 </tt><em>
h5file</em><br>
<tt>h5toh4 -m </tt><em>
h5file1
h5file2
h5file3</em> ...
<dt><strong>Purpose:</strong>
<dd>Purpose...
<dt><strong>Description:</strong>
<dd><tt>TOOL</tt> 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><tt>-option</tt>
<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 ALIGN=LEFT VALIGN=TOP><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 ALIGN=RIGHT VALIGN=TOP>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></address>
<br>Last modified: 15 December 2000
<br>Describes HDF5 Release 1.4, February 2001
</body>
</html>
|
