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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: src/H5Zdevelop.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.2908dd1</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('_h5_zdevelop_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">H5Zdevelop.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="_h5_zpublic_8h.html">H5Zpublic.h</a>"</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__cb__t.html">H5Z_cb_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html">H5Z_class2_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class1__t.html">H5Z_class1_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:acec2c757b38aefdb817ba7c7915778a9" id="r_acec2c757b38aefdb817ba7c7915778a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#acec2c757b38aefdb817ba7c7915778a9">H5Z_CLASS_T_VERS</a>   (1)</td></tr>
<tr class="separator:acec2c757b38aefdb817ba7c7915778a9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:af2d1e20aeb92b2712ebc2d9b5fcbf510" id="r_af2d1e20aeb92b2712ebc2d9b5fcbf510"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a>) (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
<tr class="memdesc:af2d1e20aeb92b2712ebc2d9b5fcbf510"><td class="mdescLeft"> </td><td class="mdescRight">This callback determines if a filter can be applied to the dataset with the characteristics provided. <br /></td></tr>
<tr class="separator:af2d1e20aeb92b2712ebc2d9b5fcbf510"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32591ae9c5164edd548c9885f430b15e" id="r_a32591ae9c5164edd548c9885f430b15e"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="#a32591ae9c5164edd548c9885f430b15e">H5Z_set_local_func_t</a>) (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
<tr class="memdesc:a32591ae9c5164edd548c9885f430b15e"><td class="mdescLeft"> </td><td class="mdescRight">The filter operation callback function, defining a filter's operation on data. <br /></td></tr>
<tr class="separator:a32591ae9c5164edd548c9885f430b15e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a130d8964a46667029c7d3c14572577c6" id="r_a130d8964a46667029c7d3c14572577c6"><td class="memItemLeft" align="right" valign="top">typedef size_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="#a130d8964a46667029c7d3c14572577c6">H5Z_func_t</a>) (unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[], size_t nbytes, size_t *buf_size, void **buf)</td></tr>
<tr class="memdesc:a130d8964a46667029c7d3c14572577c6"><td class="mdescLeft"> </td><td class="mdescRight">The filter operation callback function, defining a filter's operation on data. <br /></td></tr>
<tr class="separator:a130d8964a46667029c7d3c14572577c6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga93145acc38c2c60d832b7a9b0123706b" id="r_ga93145acc38c2c60d832b7a9b0123706b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_z.html#ga93145acc38c2c60d832b7a9b0123706b">H5Zregister</a> (const void *cls)</td></tr>
<tr class="memdesc:ga93145acc38c2c60d832b7a9b0123706b"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new filter with the HDF5 library. <br /></td></tr>
<tr class="separator:ga93145acc38c2c60d832b7a9b0123706b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6b8bcdde70c9256c50c7c62ba66380f8" id="r_ga6b8bcdde70c9256c50c7c62ba66380f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_z.html#ga6b8bcdde70c9256c50c7c62ba66380f8">H5Zunregister</a> (<a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a> id)</td></tr>
<tr class="memdesc:ga6b8bcdde70c9256c50c7c62ba66380f8"><td class="mdescLeft"> </td><td class="mdescRight">Unregisters a filter. <br /></td></tr>
<tr class="separator:ga6b8bcdde70c9256c50c7c62ba66380f8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="acec2c757b38aefdb817ba7c7915778a9" name="acec2c757b38aefdb817ba7c7915778a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acec2c757b38aefdb817ba7c7915778a9">◆ </a></span>H5Z_CLASS_T_VERS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Z_CLASS_T_VERS   (1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current version of the H5Z_class_t struct </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="af2d1e20aeb92b2712ebc2d9b5fcbf510" name="af2d1e20aeb92b2712ebc2d9b5fcbf510"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2d1e20aeb92b2712ebc2d9b5fcbf510">◆ </a></span>H5Z_can_apply_func_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a>(* H5Z_can_apply_func_t) (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback determines if a filter can be applied to the dataset with the characteristics provided. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p>Before a dataset gets created, the <a class="el" href="#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a> callbacks for any filters used in the dataset creation property list are called with the dataset's dataset creation property list, the dataset's datatype and a dataspace describing a chunk (for chunked dataset storage).</p>
<p>The <a class="el" href="#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a> callback must determine if the combination of the dataset creation property list setting, the datatype and the dataspace represent a valid combination to apply this filter to. For example, some cases of invalid combinations may involve the filter not operating correctly on certain datatypes (or certain datatype sizes), or certain sizes of the chunk dataspace.</p>
<p>The <a class="el" href="#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a> callback can be the NULL pointer, in which case, the library will assume that it can apply to any combination of dataset creation property list values, datatypes and dataspaces.</p>
<p>The <a class="el" href="#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a> callback returns positive a valid combination, zero for an invalid combination and negative for an error. </p>
</div>
</div>
<a id="a130d8964a46667029c7d3c14572577c6" name="a130d8964a46667029c7d3c14572577c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a130d8964a46667029c7d3c14572577c6">◆ </a></span>H5Z_func_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t(* H5Z_func_t) (unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[], size_t nbytes, size_t *buf_size, void **buf)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The filter operation callback function, defining a filter's operation on data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Bit vector specifying certain general properties of the filter </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cd_nelmts</td><td>Number of elements in <code>cd_values</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cd_values</td><td>Auxiliary data for the filter </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nbytes</td><td>The number of valid bytes in <code>buf</code> to be filtered </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">buf_size</td><td>The size of <code>buf</code> </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">buf</td><td>The filter buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of valid bytes of data contained in <code>buf</code>. In the case of failure, the return value is 0 (zero) and all pointer arguments are left unchanged.</dd></dl>
<p>A filter gets definition flags and invocation flags (defined above), the client data array and size defined when the filter was added to the pipeline, the size in bytes of the data on which to operate, and pointers to a buffer and its allocated size.</p>
<p>The filter should store the result in the supplied buffer if possible, otherwise it can allocate a new buffer, freeing the original. The allocated size of the new buffer should be returned through the <code>buf_size</code> pointer and the new buffer through the <code>buf</code> pointer.</p>
<p>The return value from the filter is the number of bytes in the output buffer. If an error occurs then the function should return zero and leave all pointer arguments unchanged.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="a32591ae9c5164edd548c9885f430b15e" name="a32591ae9c5164edd548c9885f430b15e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32591ae9c5164edd548c9885f430b15e">◆ </a></span>H5Z_set_local_func_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(* H5Z_set_local_func_t) (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The filter operation callback function, defining a filter's operation on data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p>After the <a class="el" href="#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a> callbacks are checked for new datasets, the <a class="el" href="#a32591ae9c5164edd548c9885f430b15e">H5Z_set_local_func_t</a> callbacks for any filters used in the dataset creation property list are called. These callbacks receive the dataset's private copy of the dataset creation property list passed in to <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> (i.e. not the actual property list passed in to <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a>) and the datatype ID passed in to <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> (which is not copied and should not be modified) and a dataspace describing the chunk (for chunked dataset storage) (which should also not be modified).</p>
<p>The <a class="el" href="#a32591ae9c5164edd548c9885f430b15e">H5Z_set_local_func_t</a> callback must set any 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 (or datatype sizes) or different number of dimensions or dataspace sizes.</p>
<p>The <a class="el" href="#a32591ae9c5164edd548c9885f430b15e">H5Z_set_local_func_t</a> callback can be the NULL pointer, in which case, the library will assume that there are no dataset-specific settings for this filter.</p>
<p>The <a class="el" href="#a32591ae9c5164edd548c9885f430b15e">H5Z_set_local_func_t</a> callback must return non-negative on success and negative for an error. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_h5_zdevelop_8h.html">H5Zdevelop.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
