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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry id='hrepack'>
<refmeta>
<refentrytitle>hrepack</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>hrepack</refname>
<refpurpose>copies an HDF file to a new file</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>hrepack</command>
<arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
<arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
<arg choice='opt'><option>-V</option></arg>
<arg choice='opt'><option>-h</option></arg>
<arg choice='opt'><option>-v</option></arg>
<arg choice='opt'><option>-t</option> <replaceable>comp_info</replaceable></arg>
<arg choice='opt'><option>-c</option> <replaceable>chunk_info</replaceable></arg>
<arg choice='opt'><option>-f</option> <replaceable>cfile</replaceable></arg>
<arg choice='opt'><option>-m</option> <replaceable>size</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
<command>hrepack</command> copies an HDF file to a new file with/without
compression and/or chunking.
</para>
</refsect1>
<refsect1 id='options'>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-i</option> <replaceable>input</replaceable></term>
<listitem>
<para>
input HDF File
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option> <replaceable>output</replaceable></term>
<listitem>
<para>
output HDF File
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<listitem>
<para>
prints version of the HDF4 library and exits
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<listitem>
<para>
prints usage information
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<listitem>
<para>
verbose mode
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option> <replaceable>comp_info</replaceable></term>
<listitem>
<para>
compression type: '<replaceable>comp_info</replaceable>' is a
string with the format
<object list>:<type of compression><parameters>
</para>
<para>
<object list> is a comma separated list of object names
meaning apply compression only to those objects.
'*' means all objects.
</para>
<para>
<type of compression> can be:
<variablelist>
<varlistitem>
<term>RLE</term>
<listitem>
<para>
for RLE compression
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>HUFF</term>
<listitem>
<para>
for Huffman
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>GZIP</term>
<listitem>
<para>
for gzip
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>JPEG</term>
<listitem>
<para>
for JPEG (for images only)
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>SZIP</term>
<listitem>
<para>
for szip
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>NONE</term>
<listitem>
<para>
to uncompress
</para>
</listitem>
</varlistitem>
</variablelist>
</para>
<para>
<parameters> is optional compression info
<variablelist>
<varlistitem>
<term>RLE</term>
<listitem>
<para>
no parameter
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>HUFF</term>
<listitem>
<para>
the skip-size
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>GZIP</term>
<listitem>
<para>
the deflation level
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>JPEG</term>
<listitem>
<para>
the quality factor
</para>
</listitem>
</varlistitem>
<varlistitem>
<term>SZIP</term>
<listitem>
<para>
pixels per block, compression mode (NN or EC)
</para>
</listitem>
</varlistitem>
</variablelist>
</para>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option> <replaceable>chunk_info</replaceable></term>
<listitem>
<para>
apply chunking.
<replaceable>chunk_info</replaceable> is a string with the format
<object list>:<chunk information>
</para>
<para>
<object list> is a comma separated list of object names
meaning apply chunking only to those objects.
'*' means all objects
</para>
<para>
<chunk information> is the chunk size of each dimension:
<replaceable>dim_1 x dim_2 x ... dim_n</replaceable> or
NONE, to unchunk a previous chunked object
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option> <replaceable>cfile</replaceable></term>
<listitem>
<para>
file with compression information <option>-t</option> and
<option>-c</option>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option> <replaceable>size</replaceable></term>
<listitem>
<para>
do not compress objects smaller than size (bytes)
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='examples'>
<title>EXAMPLES</title>
<example>
<para>
compresses all objects in the file <filename>file1.hdf</filename>,
using RLE compression
</para>
<screen>
<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'*:RLE'</literal>
</screen>
</example>
<example>
<para>
applies Skipping Huffman compression with skip factor of 1,
for objects /group1/A, /group2/B and C
</para>
<screen>
<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'/group1/A,/group2/B,C:HUFF 1'</literal>
</screen>
</example>
<example>
<para>
applies RLE compression for object /group1/D.
</para>
<para>
applies chunking to objects D and E using a chunk size of 10 for the 2 dimensions
</para>
<screen>
<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'/group1/D:RLE'</literal> <option>-c</option> <literal>'D,E:10x10'</literal>
</screen>
</example>
<example>
<para>
uncompresses object A
</para>
<screen>
<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'A:NONE'</literal>
</screen>
</example>
<example>
<para>
applies SZIP compression to object A, with parameters 8 and NN
</para>
<screen>
<command>hrepack</command> <option>-v</option> <option>-i</option> <filename>file1.hdf</filename> <option>-o</option> <filename>file2.hdf</filename> <option>-t</option> <literal>'A:SZIP 8,NN'</literal>
</screen>
<para>
Note: the use of the verbose option -v is recommended
</para>
</example>
</refsect1>
</refentry>
|
