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
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
|
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* 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://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "h5dump" -->
<p>
<hr>
<dl>
<dt><div align=right><font color=999999 size=-1><i>
Last modified: 23 August 2013
</i></font></div>
<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>files</em>
<p>
<dt><strong>Purpose:</strong>
<dd>Displays HDF5 file contents.
<p>
<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>
The <code>--header</code> option displays object header
information only.
<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>
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>
<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>
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>
<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 command 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>
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>
<em>Note</em>: It is not permissible 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>
<p>
One byte integer type data is displayed in decimal by default. When
displayed in ASCII, a non-printable code is displayed in 3 octal
digits preceeded by a back-slash unless there is a C language escape
sequence for it. For example, CR and LF are printed as \r and \n.
Though the NUL code is represented as \0 in C, it is printed as
\000 to avoid ambiguity as illustrated in the following 1 byte
char data (since this is not a string, embedded NUL is possible).
<pre>
141 142 143 000 060 061 062 012
a b c \0 0 1 2 \n </pre>
h5dump prints them as "abc\000012\n". But if h5dump prints NUL as \0,
the output is "abc\0012\n" which is ambiguous.
</p>
<p>
<strong>Using file drivers:</strong>
<br>
It is possible to select the file driver with which to open an
HDF5 file by using the <code>--filedriver</code> (or <code>-f</code>)
command-line option.
Valid values for the <code>--filedriver</code> option are
<code>sec2</code>, <code>family</code>,
<code>split</code>, and <code>multi</code>.
<!--, and <code>stream</code>.-->
If the file driver flag is not specified,
then the file will be opened with each driver in turn,
and in the order specified above,
until one driver succeeds in opening the file.
</p>
<p>
Special file naming restrictions apply when using <code>h5dump</code>
with either the <code>split</code> or the <code>multi</code> driver.
<p>
<i>To dump a split file,</i> <code>h5dump</code> requires that
the metadata and raw data filenames end with
<code>-m.h5</code> and <code>-r.h5</code>, respectively,
and that the entire virtual HDF5 file,
or the <i>logical HDF5 file</i>, be referred to
on the command line by the common portion of the filename preceding
the <code>-m</code> and <code>-r</code>.
</p>
<p>
For example, assume that a split HDF5 file has its
metadata in a file named <code>splitfile-m.h5</code> and its
raw data in a file named <code>splitfile-r.h5</code>.
The following command would dump the contents of this
logical HDF5 file:
<br><code>
h5dump --filedriver="split" splitfile</code>
</p>
<p>
Note that the above split filename restrictions are specific to
<code>h5dump</code>;
HDF5 applications do not necessarily have the same limitations.
</p>
<p>
<i>To dump a multi file,</i> <code>h5dump</code> requires that
the metadata and raw data filenames end with a subset of the following:
<br><code> </code>
<code>-s.h5</code> for userblock, superblock,
and driver information block data
<br><code> </code>
<code>-b.h5</code> for B-tree node information
<br><code> </code>
<code>-r.h5</code> for dataset raw data
<br><code> </code>
<code>-g.h5</code> for global heap data
<br><code> </code>
<code>-l.h5</code> for local heap data (object names)
<br><code> </code>
<code>-o.h5</code> for object headers
<br>
The entire virtual HDF5 file must also be referred to
on the command line by the common portion of the filename preceding
those special tags.
</p>
<p>
For example, assume that a multi HDF5 file has its
userblock, superblock, and driver information block data
in a file named <code>multifile-s.h5</code>, its
B-tree node information in a file named <code>multifile-b.h5</code>,
its raw data in a file named <code>multifile-r.h5</code>, its
global heap data in a file named <code>multifile-g.h5</code>,
et cetera.
The following command would dump the contents of this
logical HDF5 file:
<br><code>
h5dump --filedriver="multi" multifile</code>
</p>
<p>
Note that the above multi filename restrictions are specific to
<code>h5dump</code>;
HDF5 applications do not necessarily have the same limitations.
</p>
<p>
<i>To dump a family file,</i> <code>h5dump</code> requires that
the logical file’s name on the command line include the
<code>printf(3c)</code>-style integer format specifier that
specifies the format of the family file member numbers.
For example, if an HDF5 family of files consists of the files
<code>family_000.h5</code>,
<code>family_001.h5</code>,
<code>family_002.h5</code>, and
<code>family_003.h5</code>,
the logical HDF5 file would be specified on the command line as
<code>family_%3d.h5</code>.
</p>
<p>
The following command would dump the contents of this
logical HDF5 file:
<br><code>
h5dump --filedriver="family" family_%3d.h5</code>
</p>
<p>
<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://www.hdfgroup.org/HDF5/XML/software.html">HDF5
XML Software</a>.”
<p>
The XML output is suitable for use with other tools, including the
<a href="http://www.hdfgroup.org/products/java/hdf-java-html/"
target="ToolsExt">HDF5 Java Products</a>.
<p>
<dt><strong>Options and Parameters:</strong>
<dd>
<table>
<tr>
<td valign="top"><code>-h</code> or
<code>--help</code></td>
<td valign="top">Print a usage message and exit.</td>
</tr>
<tr>
<td valign="top"><code>-V</code> or
<code>--version</code></td>
<td valign="top">Print version number and exit.</td>
</tr>
<tr><td> </td><td> </td></tr>
<tr>
<td colspan="2" align="left">
<strong>Formatting options:</strong></td>
</tr>
<tr>
<td valign="top"><code>-e</code> or
<code>--escape</code></td>
<td valign="top">Escape non-printing characters.</td>
</tr>
<tr>
<td valign="top"><code>-r</code> or
<code>--string</code></td>
<td valign="top">Print 1-byte integer datasets as ASCII.</td>
</tr>
<tr>
<td valign="top"><code>-y</code> or
<code>--noindex</code></td>
<td valign="top">Do not print array indices with data.</td>
</tr>
<tr>
<td valign="top"><code>-m <em>T</em></code>
or
<code>--format=<em>T</em></code></td>
<td valign="top">Set the floating point output format.
<br>
<em>T</em> is a string defining the floating point format,
e.g., <code>'%.3f'</code>.
</td>
</tr>
<tr>
<td valign="top"><code>-q <em>Q</em></code>
or
<code>--sort_by=<em>Q</em></code></td>
<td valign="top">Sort groups and attributes by the specified
index type, <em>Q</em>.
Valid values of <em>Q</em> are as follows:
<br>
<code>name </code>
Alpha-numeric index by name <em>(Default)</em>
<br>
<code>creation_order </code>
Index by creation order
<br>
</td>
</tr>
<tr>
<td valign="top"><code>-z <em>Z</em></code>
or
<code>--sort_order=<em>Z</em></code></td>
<td valign="top">Sort groups and attributes in the specified
order, <em>Z</em>.
Valid values of <em>Z</em> are as follows:
<br>
<code>ascending </code>
Sort in ascending order <em>(Default)</em>
<br>
<code>descending </code>
Sort in descending order
</td>
</tr>
<tr>
<td valign="top"><code>--enable-error-stack</code></td>
<td valign="top">Prints messages from the HDF5 error stack
as they occur.
<p>
Injects error stack information, which is normally suppressed,
directly into the output stream.
This will disrupt normal <code>h5dump</code> output but is a
useful diagnostic tool when data is not being correctly dumped.
Consider the case when an <code>h5dump</code> call produces this
message:
<pre> dump error: unable to print data</pre>
<code>h5dump</code> can be called again with
‘<code>--enable-error-stack</code>’ plus the original
options to reveal error stack messages.
</td>
</tr>
<tr>
<td valign="top"><code>--no-compact-subset</code></td>
<td valign="top">
Enables recognition of the left square bracket
( <code><font size="+1">[</font></code> )
as a character in a dataset name.
<p>
This option must disable compact subsetting,
which is described at the end of this
“Options and Parameters” section.
</td>
</tr>
<tr>
<td valign="top"><code>-w <em>N</em></code> or
<code>--width=<em>N</em></code></td>
<td valign="top">Set the number of columns of output.
<br>
A value of 0 (zero) sets the number of columns
to the maximum (65535).
<br>
Default width is 80 columns.</td>
</tr>
<tr>
<td colspan="2" align="left">
<strong>File options:</strong></td>
</tr>
<tr>
<td valign="top"><code>-n</code> or
<code>--contents</code></td>
<td valign="top">Print a list of the file contents and exit.</td>
</tr>
<tr>
<td valign="top"><code>-n 1</code> or
<code>--contents=1</code></td>
<td valign="top">The optional value <code>1</code> (one)
on the <code>-n, --contents</code> option adds attributes
to the output.</td>
</tr>
<tr>
<td valign="top"><code>-B</code> or
<code>--superblock</code></td>
<td valign="top">Print the content of the superblock.</td>
</tr>
<tr>
<td valign="top"><code>-H</code> or
<code>--header</code></td>
<td valign="top">Print the header only; no data is displayed.</td>
</tr>
<tr>
<td valign="top"><code>-f<em> D</em></code>
or
<code>--filedriver=<em>D</em></code></td>
<td valign="top">Specify which driver to open the file with.</td>
</tr>
<tr>
<td valign="top"><code>-o <em>F</em></code>
or
<code>--output=<em>F</em></code></td>
<td valign="top">Output raw data into file F.
<p>
The files specified for the <code>-o</code> and <code>-O</code>
options must be different files.
The output from these options must not be comingled.
<p>
To suppress the raw data display, use this option with no
filename, as in either of the following examples. This has the
effect of sending the output to a <small>NULL</small> file:
<br>
<code>-o </code>
<br>
<code>--output= </code>
</td>
</tr>
<tr>
<td valign="top"><code>-b <em>B</em></code>
or
<code>--binary=<em>B</em></code></td>
<td valign="top">Output dataset to a binary file
using the datatype specified by <code><em>B</em></code>.
<br>
<code><em>B</em></code> must have one of the following values:
<br>
<code>LE </code>
Little-endian
<br>
<code>BE </code>
Big-endian
<br>
<code>MEMORY </code>
Memory datatype
<br>
<code>FILE </code>
File datatype
<br>
Recommended usage is with the <code>-d</code> and <code>-o</code>
options.
</td>
</tr>
<tr>
<td valign="top"><code>-O <em>F</em></code>
or
<code>--ddl=<em>F</em></code></td>
<td valign="top">Output DDL text into file F.
<p>
The files specified for the <code>-o</code> and <code>-O</code>
options must be different files.
The output from these options must not be comingled.
<p>
<a href="#Tools-Import"><code>h5import</code></a>
can use the files output by the <code>-o</code> and
<code>-O</code> when importing HDF5 data.
See “<a href="#Tools-Import-UsingDump">Using
<code>h5dump</code> to create input for
<code>h5import</code></a>.”
<p>
To suppress the DDL display, use this option with no filename,
as in either of the following examples. This has the effect
of sending the output to a <small>NULL</small> file:
<br>
<code>-O </code>
<br>
<code>--ddl= </code>
</td>
</tr>
<tr>
<td colspan="2" align="left">
<strong>Object options:</strong></td>
</tr>
<tr>
<td valign="top"><code>-a <em>P</em></code> or <code>--attribute=<em>P</em> </code></td>
<td valign="top">Print the specified attribute.</td>
</tr>
<tr>
<td valign="top"><code>-d <em>P</em></code>
or
<code>--dataset=<em>P</em></code></td>
<td valign="top">Print the specified dataset.</td>
</tr>
<tr>
<td valign="top"><code>-g <em>P</em></code>
or
<code>--group=<em>P</em></code></td>
<td valign="top">Print the specified group and all members.</td>
</tr>
<!-- NEW PAGE -->
<tr>
<td valign="top"><code>-l <em>P</em></code>
or
<code>--soft-link=<em>P</em></code></td>
<td valign="top">Print the value(s) of the specified soft link.
</td>
</tr>
<tr>
<td valign="top"><code>-t <em>P</em></code>
or
<code>--datatype=<em>P</em></code></td>
<td valign="top">Print the specified named datatype.</td>
</tr>
<tr>
<td valign="top"><code>-A</code> or
<code>--onlyattr</code></td>
<td valign="top">Print the header and value of attributes;
data of datasets is not displayed.</td>
</tr>
<tr>
<td valign="top"><code>-A 0</code> or
<code>--onlyattr=0</code></td>
<td valign="top">The optional value <code>0</code> (zero)
on the <code>-A, --onlyattr</code> option prints everything
<i>except</i> attributes.</td>
</tr>
<tr>
<td valign="top"><code>-N <em>P</em></code>
or
<code>--any-path=<em>P</em></code></td>
<td valign="top">Print any attribute, dataset, datatype,
group, or link whose path matches <em>P</em>.
<br>
<em>P</em> may match either the absolute path
or any portion of the path.
</td>
</tr>
<tr>
<td colspan="2" align="left">
<strong>Object property options:</strong></td>
</tr>
<tr>
<td valign="top"><code>-i</code> or
<code>--object-ids</code></td>
<td valign="top">Print the object ids.</td>
</tr>
<tr>
<td valign="top"><code>-p</code> or
<code>--properties</code>
<br>
<code> </code>
</td>
<td valign="top">Print information regarding dataset properties,
including filters, storage layout, fill value,
and allocation time.
<br>
The filter output lists any filters used with a dataset,
including the type of filter, its name, and any filter parameters.
<br>
The storage layout output specifies the dataset layout
(chunked, compact, or contiguous),
the size in bytes of the dataset on disk,
and, if a compression filter is associated with the dataset,
the compression ratio. The compression ratio is computed as
(uncompressed size)/(compressed size).
<br>
The fill value output includes the fill value datatype and value.
<br>
The allocation time output displays the allocation time as
specified with
<a href="RM_H5P.html#Property-SetAllocTime">
<code>H5Pset_alloc_time</code></a>.
</tr>
<tr>
<td valign="top"><code>-M <em>L</em></code>
or
<code>--packedbits=<em>L</em></code></td>
<td valign="top">Print packed bits as unsigned integers,
using the mask format <em>L</em> for an integer dataset
specified with option <code>-d</code>.
<br>
<em>L</em> is a list of <em>offset</em>,<em>length</em> values,
separated by commas.
<br>
<em>offset</em> is the beginning bit in the data value.
<br>
<em>length</em> is the number of bits in the mask.
</td>
</tr>
<tr>
<td valign="top"><code>-R <em></em></code>
or
<code>--region</code></td>
<td valign="top">Print dataset pointed by region references.</td>
</tr>
<tr>
<td colspan="2" align="left">
<strong>XML options:</strong></td>
</tr>
<tr>
<td valign="top"><code>-x <em></em></code>
or
<code>--xml</code></td>
<td valign="top">Output XML using XML schema (default)
instead of DDL.</td>
</tr>
<tr>
<td valign="top"><code>-u <em></em></code>
or
<code>--use-dtd</code></td>
<td valign="top">Output XML using XML DTD instead of DDL.</td>
</tr>
<tr>
<td valign="top"><code>-D <em>U</em></code>
or
<code>--xml-dtd=<em>U</em></code></td>
<td valign="top">In XML output, refer to the DTD or schema
at <em>U</em>
instead of the default schema/DTD.</td>
</tr>
<tr>
<td valign="top"><code>-X <em>S</em></code>
or
<code>--xml-ns=<em>S</em></code></td>
<td valign="top">In XML output, (XML Schema) use qualified names in
the XML:<br> ":": no namespace,
default: "hdf5:"</td>
</tr>
<!-- NEW PAGE -->
<tr>
<td colspan="2" align="left">
<strong>Subsetting options and compact subsetting:</strong>
</td>
</tr>
<tr>
<td> </td>
<td valign="top" align="left">
Subsetting is available by using the following options with
the dataset option, <code>-d</code> or <code>--dataset</code>.
Subsetting is accomplished by selecting a hyperslab from the
data, so the options mirror those for performing a hyperslab
selection.
<p>
At least one of the <code>START</code>, <code>COUNT</code>,
<code>STRIDE</code>, or <code>BLOCK</code> options is
mandatory if you do subsetting; the remainder are optional,
with default values as follows:
<br>
• <code>STRIDE</code>, <code>COUNT</code>, and
<code>BLOCK</code> default to <code>1</code>
in each dimension.
<br>
• <code>START</code> defaults to <code>0</code>
in each dimension.
</td>
</tr>
<tr>
<td valign="top"><code>-s <em>START</em></code> or
<br>
<code> --start=<em>START</em></code></td>
<td valign="top">Offset of start of subsetting selection. <br>
Default: 0 in all dimensions,
specifying the beginning of the dataset.
<p>
Each of <small><em>START</em>, <em>STRIDE</em>,
<em>COUNT</em>,</small> and <small><em>BLOCK</em></small>
must be a comma-separated list of integers
with one integer for each dimension of the dataset.
</p>
</td>
</tr>
<tr>
<td valign="top"><code>-S <em>STRIDE</em></code> or
<br>
<code> --stride=<em>STRIDE</em></code></td>
<td valign="top">Hyperslab stride. <br>
Default: 1 in all dimensions.</td>
</tr>
<tr>
<td valign="top"><code>-c <em>COUNT</em></code> or
<br>
<code> --count=<em>COUNT</em></code></td>
<td valign="top">Number of blocks to include in the selection. <br>
Default: 1 in all dimensions.</td>
</tr>
<tr>
<td valign="top"><code>-k <em>BLOCK</em></code> or
<br>
<code> --block=<em>BLOCK</em></code></td>
<td valign="top">Size of block in hyperslab. <br>
Default: 1 in all dimensions.
<p>
<b>Compact subsetting:</b>
<br>
Subsetting parameters can also be expressed in a convenient
compact form, as follows:
<br>
<code>--dataset="/foo/mydataset[START;STRIDE;COUNT;BLOCK]"</code>
<p>
It is not required to use all parameters,
but until the last parameter value used,
all of the semicolons (<code>;</code>) are required,
even when a parameter value is not specified. Example:
<br>
<code>--dataset="/foo/mydataset[START;;COUNT]"</code>
<br>
<code>--dataset="/foo/mydataset[START]"</code>
<p>
Each of <small><em>START</em>, <em>STRIDE</em>,
<em>COUNT</em>,</small> and <small><em>BLOCK</em></small>
must be a comma-separated list of integers
with one integer for each dimension of the dataset.
<p>
When not specified, default parameter values are used:
zeros ( <code>0</code> ) for <small><em>START</em></small>
and ones ( <code>1</code> ) for <small><em>STRIDE</em>,
<em>COUNT</em>,</small> and <small><em>BLOCK</em></small>.
</td>
</tr>
<tr>
<td colspan="2" align="left">
<strong>Option Argument Conventions:</strong></td>
</tr>
<tr>
<td valign="top"><code>--</code></td>
<td valign="top">Two dashes followed by whitespace.
<br>
Indicates that the following argument is not an option.
<p>
For example, this structure can be used to dump a file called
<code>-f</code>:
<pre> h5dump -- -f</pre>
This option is necessary only when the name of the file to be
examined starts with a dash (<code>-</code>), which could confuse
the tool’s command-line parser.</td>
</tr>
<tr>
<td valign="top" colspan="2">
Option parameters appearing above are defined as follows:
</td>
</tr>
<tr>
<td valign="top"><em>D</em></td>
<td valign="top">File driver to use in opening the file
<br>
Valid values are
<code>sec2</code>, <code>family</code>,
<code>split</code>, and <code>multi</code>.
<!--, and <code>stream</code>.-->
<br>
Without the file driver option, the
file will be opened with each driver in turn,
and in the order specified immediately above,
until one driver succeeds in opening the file.</td></tr>
<tr>
<td valign="top"><em>P</em></td>
<td valign="top">Path to the object
<br>
For most options, this must be the absolute path
from the root group to the object.
<br>
With the <code>-N</code>, <code>--any-path</code> option,
this may be either the absolute path or a partial path.
</td></tr>
<tr>
<td valign="top"><em>F</em></td>
<td valign="top">A filename</td></tr>
<tr>
<td valign="top"><em>N</em></td>
<td valign="top">An integer greater than 1</td></tr>
<tr>
<td valign="top" ><em>START</em>, <em>STRIDE</em>,
<br><code> </code>
<em>COUNT</em>, and <em>BLOCK</em></td>
<td valign="top">Comma-separated lists of integers
<br>
Each of these option parameters must be a list of integers
with one integer for each dimension of the dataspace being
queried.</td></tr>
<tr>
<td valign="top"><em>U</em></td>
<td valign="top">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</td></tr>
<tr>
<td valign="top"><em>B</em></td>
<td valign="top">The form of binary output:<br>
<code>MEMORY</code>
for a memory type<br>
<code>FILE </code>
for the file type<br>
<code>LE</code> or <code>BE</code>
for pre-existing little- or big-endian types
</td></tr>
<tr>
<td colspan="2" align="left">
<strong><i>Files</i> parameter:</strong></td>
</tr>
<tr>
<td valign="top"><code><em>files</em></code></td>
<td valign="top">File or files to be examined;
one or more files may be listed.
<p>
The file name may include a <code>printf(3C)</code>
integer format such as <code>%05d</code> to open a file family.
<p>
On Unix, Linux, and Mac OS X systems,
multiple files can be examined through the use of
Unix-style wildcards.
For example, assume that we are working with the files
<code>FileA.h5</code>, <code>FileB.h5</code>,
<code>FileC.h5</code>, and <code>FileAB.h5</code>:
<ul>
<li><code>File[AB].h5</code> will pick up any file
that begins with <code>File</code>,
followed by any one of the characters contained
in the square brackets,
and ending with <code>.h5</code>.
<p>
In this case, <code>File[AB].h5</code> will pick up
the files <code>FileA.h5</code> and <code>FileB.h5</code>.
<li><code>File?.h5</code> will pick up all files
whose names are <code>File</code>,
followed by exactly 1 character (any character),
followed by <code>.h5</code>.
<p>
In this case, <code>File?.h5</code> will pick up the files
<code>FileA.h5</code> and <code>FileB.h5</code>,
and <code>FileC.h5</code>.
<li><code>File*.h5</code> will pick up all files
whose names begin with <code>File</code>
and end with <code>.h5</code>.
<p>
In this case, <code>File*.h5</code> will pick up
all four files.
</ul>
<p>
The wildcard capability is not currently available
on Windows systems.
</td>
</tr>
</table>
</dd>
<p>
<dt><strong>Exit Status:</strong></dt>
<dd><table border=0>
<tr valign=top align=left>
<td>0</td>
<td>Succeeded.</td>
</tr>
<tr valign=top align=left>
<td>> 0 </td>
<td>An error occurred.</td>
</tr>
</table>
<p>
<dt><strong>Examples:</strong>
<dd>
<ol>
<li>Dump the group <code>/GroupFoo/GroupBar</code> in the file
<code>quux.h5</code>:<br>
<code>
h5dump -g /GroupFoo/GroupBar quux.h5</code>
<br>
<br>
<li>Dump the dataset <code>Fnord</code>, which is in the group
<code>/GroupFoo/GroupBar</code> in the file <code>quux.h5</code>:<br>
<code>
h5dump -d /GroupFoo/GroupBar/Fnord quux.h5</code>
<br>
<br>
<li>Dump the attribute <code>metadata</code> of the dataset
<code>Fnord</code>, which is in the group
<code>/GroupFoo/GroupBar</code> in the file <code>quux.h5</code>:<br>
<code>
h5dump -a /GroupFoo/GroupBar/Fnord/metadata quux.h5</code>
<br>
<br>
<li>Dump the attribute <code>metadata</code> which is an
attribute of the root group in the file <code>quux.h5</code>:<br>
<code>
h5dump -a /metadata quux.h5</code>
<br>
<br>
<li>Produce an XML listing of the file <code>bobo.h5</code>,
saving the listing in the file <code>bobo.h5.xml</code>:<br>
<code>
h5dump --xml bobo.h5 > bobo.h5.xml</code>
<br>
<br>
<li>Dump a subset of the dataset <code>/GroupFoo/databar/</code>
in the file <code>quux.h5</code>:<br>
<code>
h5dump -d /GroupFoo/databar --start="1,1" --stride="2,3"
<br>
--count="3,19" --block="1,1" quux.h5</code>
<br>
<br>
<li>The same example, using the short form to specify the
subsetting parameters:<br>
<code>
h5dump -d "/GroupFoo/databar[1,1;2,3;3,19;1,1]" quux.h5</code>
<br>
<br>
<li>Dump a binary copy of the dataset <code>/GroupD/FreshData/</code>
in the file <code>quux.h5</code>, with data written in little-endian
form, to the output file <code>FreshDataD.bin</code>:<br>
<code>
h5dump -d "/GroupD/FreshData" -b LE
<br>
-o "FreshDataD.bin" quux.h5</code>
<br>
<br>
<li>Display two sets of packed bits (bits 0-1 and bits 4-6) in the
dataset <code>/dset</code> of the file <code>quux.h5</code>:<br>
<code>
h5dump -d /dset -M 0,1,4,3 quux.h5 </code>
<br>
<br>
<li>Dump the dataset <code>/GroupFoo/GroupBar/Fnord</code>
to the file <code>quux.h5</code> and
output the DDL into the file <code>ddl.txt</code> and
the raw data into the file <code>data.txt</code>:<br>
<code>
h5dump -d /GroupFoo/GroupBar/Fnord --ddl=ddl.txt -y
<br>
-o data.txt quux.h5 </code>
<br>
<br>
<li>Dump the dataset <code>/GroupFoo/GroupBar/Fnord</code>
to the file <code>quux.h5</code>,
suppress the DDL output,
and output the raw data into the file <code>data.txt</code>:<br>
<code>
h5dump -d /GroupFoo/GroupBar/Fnord --ddl= -y
<br>
-o data.txt quux.h5</code>
<br>
<br>
</ol>
</dd>
<p>
<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>
<!-- NEW PAGE -->
<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, ...
<br>
- packed bits display
<br>
- integer types only
<br>
- limited to first 8 bits
<br>
- applied globally to all integer values,
including inside compound types
<li>bitfield type
<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>
<p>
<dt><strong>See Also:</strong>
<dd>
<table border="0" width="100%">
<tr><td valign="top">
<li>HDF5 Data Description Language syntax at
<a href="../ddl.html"><cite>DDL for HDF5</cite></a>
<li>HDF5 XML Schema at
<a href="http://www.hdfgroup.org/HDF5/XML/schema/HDF5-File.xsd">http://www.hdfgroup.org/HDF5/XML/schema/HDF5-File.xsd</a>
<li>HDF5 XML information at
<a href="http://www.hdfgroup.org/HDF5/XML/">http://www.hdfgroup.org/HDF5/XML/</a>
</td></tr>
</table>
</dd>
<p>
<dt><strong>History:</strong>
<dd><table width="90%" id="table2">
<tr>
<td valign="top" align="left" width="10%">
<strong>Release</strong>
</td>
<td valign="top" align="left">
<strong>Change</strong>
</td></tr>
<tr>
<td valign="top">1.8.12</td>
<td valign="top">
Optional value of <code>0</code> (zero) for the
<code>-A, --onlyattr</code> option added in this release.
<p>
Option added in this release:
<br>
<code> -N <em>P</em></code>
or
<code>--any-path=<em>P</em></code>
</td></tr>
<tr>
<td valign="top">1.8.11</td>
<td valign="top">
Option added in this release:
<br>
<code> -O <em>F</em></code>
or
<code>--ddl=<em>F</em></code>
<br>
This option can be used to suppress the DDL output.
<br>
This option, combined with the <code>'--output=<em>F</em>'</code>
(or <code>'-o <em>F'</em></code>) option
will generate files that can be used as input to
<a href="#Tools-Import"><code>h5import</code></a>.
<p>
<code>h5dump</code> updated in this release to display the
compression ratio for user-defined filters.
<p>
In <code>h5dump</code> output,
<code>UNKNOWN_FILTER</code> has been changed to
<code>USER_DEFINED_FILTER</code>.
</td></tr>
<tr>
<td valign="top">1.8.9</td>
<td valign="top">
Option added in this release:
<br>
<code> --no-compact-subset</code>
<p>
<code>h5dump</code> output has been updated for
this release to improve compliance with the
HDF5 DDL <a href="../ddl.html">specification</a>
and to improve readablilty.
This output is now fully compliant with the
HDF5 DDL specification, but these changes may affect
some user scripts:
<ul>
<li>Whitespace has been modified.
<li>Display errors, such as misplaced brackets,
have been fixed.
<li>When printing superblock content,
user block content is now properly displayed within
the superblock.
</ul>
</td></tr>
<tr>
<td valign="top">1.8.7</td>
<td valign="top">
Option added in this release:
<br>
<code> --enable-error-stack</code>
<p>
Tool updated in this release to correctly display reference type:
<br>
<code> H5T_REFERENCE {H5T_STD_REF_OBJ}</code>
for object references
<br>
<code> H5T_REFERENCE {H5T_STD_REF_DSETREG}</code>
for dataset region references
</td></tr>
<tr>
<td valign="top">1.8.5</td>
<td valign="top">
Bitfield display fixed in this release.
<p>
Option added in this release for packed bits data display:
<br>
<code> -M</code>
or
<code>--packedbits</code> option
</td></tr>
<tr>
<td valign="top">1.8.4</td>
<td valign="top">
Option added in this release for region reference display:
<br>
<code> -R</code>
or
<code>--region</code> option
</td></tr>
<tr>
<td valign="top">1.8.1</td>
<td valign="top">
Compression ratio added to output of
<code>-p</code> or <code>--properties</code> option
in this release.
</td></tr>
<tr>
<td valign="top">1.8.0</td>
<td valign="top">
Options added in this release:
<br>
<code> -q</code> or <code>--sort_by</code>
<br>
<code> -z</code> or <code>--sort_order</code>
</td></tr>
<tr>
<td valign="top">1.6.5</td>
<td valign="top">
Options added in this release:
<br>
<code> -n</code> or <code>--contents</code>
<br>
<code> -e</code> or <code>--escape</code>
<br>
<code> -y</code> or <code>--noindex</code>
<br>
<code> -p</code> or <code>--properties</code>
<br>
<code> -b</code> or <code>--binary</code>
</td></tr>
</table></dd>
</dl>
|
