blob: 619cb2019f24cf46243fa82aab60659ff2dea1e7 (
plain)
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
|
<!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: Szip Filter</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.7aed6ab</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('group___s_z_i_p.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="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">Szip Filter<div class="ingroups"><a class="el" href="group___h5_z.html">Filters (H5Z)</a> » <a class="el" href="group___h5_z_p_r_e.html">Predefined Filters</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<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:gaaf65cf1b52ad5838a9a4a4f50e58ff58" id="r_gaaf65cf1b52ad5838a9a4a4f50e58ff58"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaf65cf1b52ad5838a9a4a4f50e58ff58">H5_SZIP_ALLOW_K13_OPTION_MASK</a>   1</td></tr>
<tr class="separator:gaaf65cf1b52ad5838a9a4a4f50e58ff58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab793ee579fe535108b3c36eb1155adf3" id="r_gab793ee579fe535108b3c36eb1155adf3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab793ee579fe535108b3c36eb1155adf3">H5_SZIP_CHIP_OPTION_MASK</a>   2</td></tr>
<tr class="separator:gab793ee579fe535108b3c36eb1155adf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf55e168a1f7aaf8a94d820a2210fccb9" id="r_gaf55e168a1f7aaf8a94d820a2210fccb9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf55e168a1f7aaf8a94d820a2210fccb9">H5_SZIP_EC_OPTION_MASK</a>   4</td></tr>
<tr class="separator:gaf55e168a1f7aaf8a94d820a2210fccb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga688fde8106225adf9e6ccd2a168dec74" id="r_ga688fde8106225adf9e6ccd2a168dec74"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga688fde8106225adf9e6ccd2a168dec74">H5_SZIP_NN_OPTION_MASK</a>   32</td></tr>
<tr class="separator:ga688fde8106225adf9e6ccd2a168dec74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80441e433f29ebfbdae7c39ed6acad14" id="r_ga80441e433f29ebfbdae7c39ed6acad14"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga80441e433f29ebfbdae7c39ed6acad14">H5_SZIP_MAX_PIXELS_PER_BLOCK</a>   32</td></tr>
<tr class="separator:ga80441e433f29ebfbdae7c39ed6acad14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaedfb471b9bda9e249867b39c7924beab" id="r_gaedfb471b9bda9e249867b39c7924beab"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaedfb471b9bda9e249867b39c7924beab">H5Z_SZIP_USER_NPARMS</a>   2</td></tr>
<tr class="separator:gaedfb471b9bda9e249867b39c7924beab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80d6e257687c2cbcaeb23ba24d370e40" id="r_ga80d6e257687c2cbcaeb23ba24d370e40"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga80d6e257687c2cbcaeb23ba24d370e40">H5Z_SZIP_TOTAL_NPARMS</a>   4</td></tr>
<tr class="separator:ga80d6e257687c2cbcaeb23ba24d370e40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19bed4cd8168491cfa8362b5d9d60d22" id="r_ga19bed4cd8168491cfa8362b5d9d60d22"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga19bed4cd8168491cfa8362b5d9d60d22">H5Z_SZIP_PARM_MASK</a>   0</td></tr>
<tr class="separator:ga19bed4cd8168491cfa8362b5d9d60d22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga71b384d61d84683de9e7d260aa3c740d" id="r_ga71b384d61d84683de9e7d260aa3c740d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga71b384d61d84683de9e7d260aa3c740d">H5Z_SZIP_PARM_PPB</a>   1</td></tr>
<tr class="separator:ga71b384d61d84683de9e7d260aa3c740d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ceb7717492a16c444b992b33a8b0ca1" id="r_ga5ceb7717492a16c444b992b33a8b0ca1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5ceb7717492a16c444b992b33a8b0ca1">H5Z_SZIP_PARM_BPP</a>   2</td></tr>
<tr class="separator:ga5ceb7717492a16c444b992b33a8b0ca1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3efe033419e37f8b65ccf1f27a642300" id="r_ga3efe033419e37f8b65ccf1f27a642300"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3efe033419e37f8b65ccf1f27a642300">H5Z_SZIP_PARM_PPS</a>   3</td></tr>
<tr class="separator:ga3efe033419e37f8b65ccf1f27a642300"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaaf65cf1b52ad5838a9a4a4f50e58ff58" name="gaaf65cf1b52ad5838a9a4a4f50e58ff58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaf65cf1b52ad5838a9a4a4f50e58ff58">◆ </a></span>H5_SZIP_ALLOW_K13_OPTION_MASK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5_SZIP_ALLOW_K13_OPTION_MASK   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Used internally. Always added to the <code>options_mask</code> parameter of <a class="el" href="group___d_c_p_l.html#ga37de4b6071a94574cfab5cd6de9c3fc6" title="Sets up use of the SZIP compression filter.">H5Pset_szip()</a>. </p>
</div>
</div>
<a id="gab793ee579fe535108b3c36eb1155adf3" name="gab793ee579fe535108b3c36eb1155adf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab793ee579fe535108b3c36eb1155adf3">◆ </a></span>H5_SZIP_CHIP_OPTION_MASK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5_SZIP_CHIP_OPTION_MASK   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Used internally. Always removed from the <code>options_mask</code> parameter of <a class="el" href="group___d_c_p_l.html#ga37de4b6071a94574cfab5cd6de9c3fc6" title="Sets up use of the SZIP compression filter.">H5Pset_szip()</a>. </p>
</div>
</div>
<a id="gaf55e168a1f7aaf8a94d820a2210fccb9" name="gaf55e168a1f7aaf8a94d820a2210fccb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf55e168a1f7aaf8a94d820a2210fccb9">◆ </a></span>H5_SZIP_EC_OPTION_MASK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5_SZIP_EC_OPTION_MASK   4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use the entropy coding method </p>
</div>
</div>
<a id="ga80441e433f29ebfbdae7c39ed6acad14" name="ga80441e433f29ebfbdae7c39ed6acad14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga80441e433f29ebfbdae7c39ed6acad14">◆ </a></span>H5_SZIP_MAX_PIXELS_PER_BLOCK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5_SZIP_MAX_PIXELS_PER_BLOCK   32</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum number of pixels per block (see <a class="el" href="group___d_c_p_l.html#ga37de4b6071a94574cfab5cd6de9c3fc6" title="Sets up use of the SZIP compression filter.">H5Pset_szip()</a>) </p>
</div>
</div>
<a id="ga688fde8106225adf9e6ccd2a168dec74" name="ga688fde8106225adf9e6ccd2a168dec74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga688fde8106225adf9e6ccd2a168dec74">◆ </a></span>H5_SZIP_NN_OPTION_MASK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5_SZIP_NN_OPTION_MASK   32</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use nearest neighbor preprocessing and then the entropy coding method </p>
</div>
</div>
<a id="ga5ceb7717492a16c444b992b33a8b0ca1" name="ga5ceb7717492a16c444b992b33a8b0ca1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5ceb7717492a16c444b992b33a8b0ca1">◆ </a></span>H5Z_SZIP_PARM_BPP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Z_SZIP_PARM_BPP   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>"Local" parameter for bits-per-pixel </p>
</div>
</div>
<a id="ga19bed4cd8168491cfa8362b5d9d60d22" name="ga19bed4cd8168491cfa8362b5d9d60d22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga19bed4cd8168491cfa8362b5d9d60d22">◆ </a></span>H5Z_SZIP_PARM_MASK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Z_SZIP_PARM_MASK   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>"User" parameter for option mask </p>
</div>
</div>
<a id="ga71b384d61d84683de9e7d260aa3c740d" name="ga71b384d61d84683de9e7d260aa3c740d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga71b384d61d84683de9e7d260aa3c740d">◆ </a></span>H5Z_SZIP_PARM_PPB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Z_SZIP_PARM_PPB   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>"User" parameter for pixels-per-block </p>
</div>
</div>
<a id="ga3efe033419e37f8b65ccf1f27a642300" name="ga3efe033419e37f8b65ccf1f27a642300"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3efe033419e37f8b65ccf1f27a642300">◆ </a></span>H5Z_SZIP_PARM_PPS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Z_SZIP_PARM_PPS   3</td>
</tr>
</table>
</div><div class="memdoc">
<p>"Local" parameter for pixels-per-scanline </p>
</div>
</div>
<a id="ga80d6e257687c2cbcaeb23ba24d370e40" name="ga80d6e257687c2cbcaeb23ba24d370e40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga80d6e257687c2cbcaeb23ba24d370e40">◆ </a></span>H5Z_SZIP_TOTAL_NPARMS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Z_SZIP_TOTAL_NPARMS   4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of parameters for SZIP filter </p>
</div>
</div>
<a id="gaedfb471b9bda9e249867b39c7924beab" name="gaedfb471b9bda9e249867b39c7924beab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaedfb471b9bda9e249867b39c7924beab">◆ </a></span>H5Z_SZIP_USER_NPARMS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Z_SZIP_USER_NPARMS   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of parameters that users can set for SZIP </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="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>
|