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
|
<html>
<head>
<title>
HDF5/H5Z API Specification
</title>
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<link href="ed_styles/RMelect.css" rel="stylesheet" type="text/css">
<!-- #EndLibraryItem --></head>
<body bgcolor="#FFFFFF">
<!-- HEADER RIGHT " " -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a> <br>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</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>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr><!-- #EndLibraryItem --><center>
<h1>H5Z: Filter and Compression Interface</h1>
</center>
<h2>Filter and Compression API Functions</h2>
These functions enable the user to configure new filters
for the local environment.
<table border=0 width=80%>
<tr><td valign=top>
<ul>
<li><a href="#Compression-FilterAvail">H5Zfilter_avail</a>
</ul>
</td><td> </td><td valign=top>
<ul>
<li><a href="#Compression-Register">H5Zregister</a>
</ul>
</td><td> </td><td valign=top>
<ul>
<li><a href="#Compression-Unregister">H5Zunregister</a>
</ul>
</td></tr>
</table>
<br>
<strong>The FORTRAN90 Interfaces:</strong>
<br>
In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function.
<br>
<table border=0 width=80%>
<tr><td valign=top>
<ul>
<li><a href="#Compression-FilterAvail">h5zfilter_avail_f</a>
</ul>
</td><td> </td><td valign=top>
<ul>
<!--<li><a href="#Compression-Register">h5zregister_f</a> -->
</ul>
</td><td> </td><td valign=top>
<ul>
<li><a href="#Compression-Unregister">h5zunregister_f</a>
</ul>
</td></tr>
</table>
<p>
HDF5 supports a filter pipeline that provides the capability for standard
and customized raw data processing during I/O operations.
HDF5 is distributed with a small set of standard filters such as
compression (gzip, SZIP, and a shuffling algorithm) and
error checking (Fletcher32 checksum).
For further flexibility, the library allows a
user application to extend the pipeline through the
creation and registration of customized filters.
<p>
The flexibility of the filter pipeline implementation enables the
definition of additional filters by a user application.
A filter
<ul>
<li>is associated with a dataset when the dataset is created,
<li>can be used only with chunked data
(i.e., datasets stored in the <code>H5D_CHUNKED</code>
storage layout), and
<li>is applied independently to each chunk of the dataset.
</ul>
<p>
The HDF5 library does not support filters for contiguous datasets
because of the difficulty of implementing random access for partial I/O.
Compact dataset filters are not supported because it would not produce
significant results.
<p>
Filter identifiers for the filters distributed with the HDF5 Library
are as follows:
<table align=center border=0>
<tr valign=top align=left>
<td>
<code>H5Z_FILTER_DEFLATE</code></td><td>The gzip compression,
or deflation, filter
</td></tr><tr><td>
<code>H5Z_FILTER_SZIP</code></td><td>The SZIP compression filter
</td></tr><tr><td>
<code>H5Z_FILTER_SHUFFLE</code></td><td>The shuffle algorithm filter
</td></tr><tr><td>
<code>H5Z_FILTER_FLETCHER32 </code></td><td>The Fletcher32 checksum,
or error checking, filter
</td></tr>
</table>
Custom filters that have been registered with the library will have
additional unique identifiers.
<p>
See <a href="Datasets.html"><cite>The Dataset Interface (H5D)</cite></a>
in the <cite>HDF5 User's Guide</cite> for further information regarding
data compression.
<!-- NEW PAGE -->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Zfilter_avail" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Compression-FilterAvail">H5Zfilter_avail</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Zfilter_avail</code>(<em>H5Z_filter_t</em> <code>filter</code>)
<dt><strong>Purpose:</strong>
<dd>Determines whether a filter is available.
<dt><strong>Description:</strong>
<dd><code>H5Zfilter_avail</code> determines whether the filter
specified in <code>filter</code> is available to the application.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td>
<td valign="top">IN: Filter identifier.
See the introduction to this section of the reference manual
for a list of valid filter identifiers</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5zfilter_avail_f
<dd>
<pre>
SUBROUTINE h5zfilter_avail_f(filter, status, hdferr)
IMPLICIT NONE
INTEGER, INTENT(IN) :: filter ! Filter
! Valid values are:
! H5Z_FILTER_DEFLATE_F
! H5Z_FILTER_SHUFFLE_F
! H5Z_FILTER_FLETCHER32_F
! H5Z_FILTER_SZIP_F
LOGICAL, INTENT(OUT) :: status ! Flag indicating whether
! filter is available:
! .TRUE.
! .FALSE.
END SUBROUTINE h5zfilter_avail_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Zregister" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Compression-Register">H5Zregister</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Zregister</code>(<em>const H5Z_class_t</em> <code>filter_class</code>)
)
<dt><strong>Purpose:</strong>
<dd>Registers new filter.
<dt><strong>Description:</strong>
<dd><code>H5Zregister</code> registers a new filter with the
HDF5 library.
<p>
Making a new filter available to an application is a two-step
process. The first step is to write
the three filter callback functions described below:
<code>can_apply_func</code>, <code>set_local_func</code>, and
<code>filter_func</code>.
This call to <code>H5Zregister</code>,
<span class="termEmphasis">registering</span> the filter with the
library, is the second step.
The <code>can_apply_func</code> and <code>set_local_func</code>
fields can be set to <code>NULL</code>
if they are not required for the filter being registered.
<p>
<code>H5Zregister</code> accepts a single parameter,
the <code>filter_class</code> data structure,
which is defined as follows:
<pre>
typedef struct H5Z_class_t {
H5Z_filter_t filter_id;
const char *comment;
H5Z_can_apply_func_t can_apply_func;
H5Z_set_local_func_t set_local_func;
H5Z_func_t filter_func;
} H5Z_class_t;
</pre>
<p>
<code>filter_id</code> is the identifier for the new filter.
This is a user-defined value between
<code>H5Z_FILTER_RESERVED</code> and <code>H5Z_FILTER_MAX</code>,
both of which are defined in the HDF5 source file
<code>H5Zpublic.h</code>.
<p>
<code>comment</code> is used for debugging,
may contain a descriptive name for the filter,
and may be the null pointer.
<p>
<code>can_apply_func</code>, described in detail below,
is a user-defined callback function which determines whether
the combination of the dataset creation property list values,
the datatype, and the dataspace represent a valid combination
to apply this filter to.
<p>
<code>set_local_func</code>, described in detail below,
is a user-defined callback function which sets any parameters that
are specific to this dataset, based on the combination of the
dataset creation property list values, the datatype, and the
dataspace.
<p>
<code>filter_func</code>, described in detail below,
is a user-defined callback function which performs the action
of the filter.
<p>
The statistics associated with a filter are not reset
by this function; they accumulate over the life of the library.
<p>
<strong>The callback functions</strong>
<br>
Before <code>H5Zregister</code> can link a filter into an
application, three callback functions must be defined
as described in the HDF5 Library header file <code>H5Zpublic.h</code>.
<p>
<u>The <i>can apply</i> callback function</u> is defined as follows:<br>
<dir>
<em>typedef herr_t</em> (*<code>H5Z_can_apply_func_t</code>)
(<em>hid_t</em> <code>dcpl_id</code>,
<em>hid_t</em> <code>type_id</code>,
<em>hid_t</em> <code>space_id</code>)
</dir>
<p>
Before a dataset is created, the <i>can apply</i> callbacks for
any filters used in the dataset creation property list are called
with the dataset's dataset creation property list, <code>dcpl_id</code>,
the dataset's datatype, <code>type_id</code>, and
a dataspace describing a chunk, <code>space_id</code>,
(for chunked dataset storage).
<p>
This callback must determine whether the combination of the
dataset creation property list settings, the datatype, and the
dataspace represent a valid combination to which to apply this filter.
For example, an invalid combination may involve
the filter not operating correctly on certain datatypes,
on certain datatype sizes, or on certain sizes of the chunk dataspace.
<p>
This callback can be the <code>NULL</code> pointer, in which case
the library will assume that the filter can be applied to a dataset with
any combination of dataset creation property list values, datatypes,
and dataspaces.
<p>
The <i>can apply</i> callback function must return
a positive value for a valid combination,
zero for an invalid combination, and
a negative value for an error.
<p>
<u>The <i>set local</i> callback function</u> is defined as follows:<br>
<dir>
<em>typedef herr_t</em> (*<code>H5Z_set_local_func_t</code>)
(<em>hid_t</em> <code>dcpl_id</code>,
<em>hid_t</em> <code>type_id</code>,
<em>hid_t</em> <code>space_id</code>)
</dir>
<p>
After the <i>can apply</i> callbacks are checked for a new dataset,
the <i>set local</i> callback functions for any filters used in the
dataset creation property list are called.
These callbacks receive
<code>dcpl_id</code>, the dataset's private copy of the dataset
creation property list passed in to <code>H5Dcreate</code>
(i.e. not the actual property list passed in to <code>H5Dcreate</code>);
<code>type_id</code>, the datatype identifier passed in to
<code>H5Dcreate</code>,
which is not copied and should not be modified; and
<code>space_id</code>, a dataspace describing the chunk
(for chunked dataset storage), which should also not be modified.
<p>
The <i>set local</i> callback must set any filter parameters that are
specific to this dataset, based on the combination of the
dataset creation property list values, the datatype, and the dataspace.
For example, some filters perform different actions based on
different datatypes, datatype sizes, numbers of dimensions,
or dataspace sizes.
<p>
The <i>set local</i> callback may be the <code>NULL</code> pointer,
in which case, the library will assume that there are
no dataset-specific settings for this filter.
<p>
The <i>set local</i> callback function must return
a non-negative value on success and
a negative value for an error.
<p>
<u>The <i>filter operation</i> callback function</u>,
defining the filter's operation on the data, is defined as follows:
<dir>
<em>typedef size_t</em> (*<code>H5Z_func_t</code>)
(<em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_nelmts</code>,
<em>const unsigned int</em> <code>cd_values[]</code>,
<em>size_t</em> <code>nbytes</code>,
<em>size_t *</em><code>buf_size</code>,
<em>void **</em><code>buf</code>)
</dir>
<p>
The parameters <code>flags</code>, <code>cd_nelmts</code>,
and <code>cd_values</code> are the same as for the function
<a href="RM_H5P.html#Property-SetFilter"><code>H5Pset_filter</code></a>.
The one exception is that an additional flag,
<code>H5Z_FLAG_REVERSE</code>, is set when
the filter is called as part of the input pipeline.
<p>
The parameter <code>*buf</code> points to the input buffer
which has a size of <code>*buf_size</code> bytes,
<code>nbytes</code> of which are valid data.
<p>
The filter should perform the transformation in place if
possible. If the transformation cannot be done in place,
then the filter should allocate a new buffer with
<code>malloc()</code> and assign it to <code>*buf</code>,
assigning the allocated size of that buffer to
<code>*buf_size</code>.
The old buffer should be freed by calling <code>free()</code>.
<p>
If successful, the <i>filter operation</i> callback function
returns the number of valid bytes of data contained in <code>*buf</code>.
In the case of failure, the return value is <code>0</code> (zero)
and all pointer arguments are left unchanged.
<dt><strong>Note:</strong>
<dd>The <code>H5Zregister</code> interface is substantially revised
from the HDF5 Release 1.4.x series.
The <code>H5Z_class_t</code> struct and
the <i>set local</i> and <i>can apply</i> callback functions
first appeared in HDF5 Release 1.6.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>const H5Z_class_t</em> <code>filter_class </code></td>
<td valign="top">IN: Struct containing filter-definition information.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Zunregister" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Compression-Unregister">H5Zunregister</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Zunregister</code>(<em>H5Z_filter_t</em> <code>filter</code>)
<dt><strong>Purpose:</strong>
<dd>Unregisters a filter.
<dt><strong>Description:</strong>
<dd><code>H5Zunregister</code> unregisters the filter
specified in <code>filter</code>.
<p>
After a call to <code>H5Zunregister</code>, the filter
specified in <code>filter</code> will no longer be
available to the application.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td>
<td valign="top">IN: Identifier of the filter to be unregistered.
See the introduction to this section of the reference manual
for a list of valid filter identifiers</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5zunregister_f
<dd>
<pre>
SUBROUTINE h5zunregister_f(filter, hdferr)
IMPLICIT NONE
INTEGER, INTENT(IN) :: filter ! Filter; one of the possible values:
! H5Z_FILTER_DEFLATE_F
! H5Z_FILTER_SHUFFLE_F
! H5Z_FILTER_FLETCHER32_F
! H5Z_FILTER_SZIP_F
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success, and -1 on failure
END SUBROUTINE h5zunregister_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- HEADER RIGHT " " -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a> <br>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</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>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 1 July 2004");
-->
</SCRIPT>
</body>
</html>
|
