forked from Novartis/hdf5r
-
Notifications
You must be signed in to change notification settings - Fork 23
/
H5P_DATASET_CREATE-class.html
254 lines (177 loc) · 13.6 KB
/
H5P_DATASET_CREATE-class.html
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
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Class for HDF5 property list for dataset creation — H5P_DATASET_CREATE-class • hdf5r</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.1/css/all.min.css" integrity="sha256-PbSmjxuVAzJ6FPvNYsrXygfGhNJYyZ2GktDbkMBqQZg=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.1/css/v4-shims.min.css" integrity="sha256-A6jcAdwFD48VMjlI3GDxUd+eCQa7/KWy6G9oe/ovaPA=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Class for HDF5 property list for dataset creation — H5P_DATASET_CREATE-class" />
<meta property="og:description" content="It inherits all functions of the H5P." />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">hdf5r</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.3.2</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../articles/hdf5r.html">Get started</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/hhoeflin/hdf5r">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Class for HDF5 property list for dataset creation</h1>
<small class="dont-index">Source: <a href='https://github.com/hhoeflin/hdf5r/blob/master/R/R6Classes_H5P.R'><code>R/R6Classes_H5P.R</code></a></small>
<div class="hidden name"><code>H5P_DATASET_CREATE-class.Rd</code></div>
</div>
<div class="ref-description">
<p>It inherits all functions of the <code>H5P</code>.</p>
</div>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>Object of class <code>H5P_DATASET_CREATE</code>.</p>
<h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2>
<dl class='dl-horizontal'>
<dt><code>new(id = NULL)</code></dt><dd><p>Create a new class of type <code>H5P_DATASET_CREATE</code><strong>Parameters</strong>
<dl class='dl-horizontal'>
<dt>id</dt><dd><p>Internal use only</p></dd></dl></p></dd>
<dt><code>set_layout(layout = h5const$H5D_CHUNKED)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_layout.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_LAYOUT'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_LAYOUT</a> for details.</p></dd>
<dt><code>get_layout()</code></dt><dd><p>This function implements the HDF5-API function H5Pget_layout.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_LAYOUT'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_LAYOUT</a> for details.</p></dd>
<dt><code>set_chunk(chunk)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_chunk.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_CHUNK'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_CHUNK</a> for details.</p></dd>
<dt><code>get_chunk(max_ndims)</code></dt><dd><p>This function implements the HDF5-API function H5Pget_chunk.
If the layout is not chunked, returns NA.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_CHUNK'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_CHUNK</a> for details.</p></dd>
<dt><code>set_deflate(level)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_deflate.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_DEFLATE'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_DEFLATE</a> for details.</p></dd>
<dt><code>set_fill_value(dtype, value)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_fill_value.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILL_VALUE'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILL_VALUE</a> for details.</p></dd>
<dt><code>get_fill_value(dtype)</code></dt><dd><p>This function implements the HDF5-API function H5Pget_fill_value.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILL_VALUE'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILL_VALUE</a> for details.</p></dd>
<dt><code>set_fill_time(fill_time = h5const$H5D_FILL_TIME_IFSET)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_fill_time.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILL_TIME'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILL_TIME</a> for details.</p></dd>
<dt><code>get_fill_time()</code></dt><dd><p>This function implements the HDF5-API function H5Pget_fill_time.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILL_TIME'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILL_TIME</a> for details.</p></dd>
<dt><code>set_alloc_time(alloc_time = h5const$H5D_ALLOC_TIME_DEFAULT)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_alloc_time.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_ALLOC_TIME'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_ALLOC_TIME</a> for details.</p></dd>
<dt><code>get_alloc_time()</code></dt><dd><p>This function implements the HDF5-API function H5Pget_alloc_time.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_ALLOC_TIME'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_ALLOC_TIME</a> for details.</p></dd>
<dt><code>set_filter(filter = h5const$H5Z_FILTER_DEFLATE,
flags = h5const$H5Z_FLAG_OPTIONAL, cd_values = integer(0))</code></dt><dd><p>This function implements the HDF5-API function H5Pset_filter.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILTER'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILTER</a> for details.</p></dd>
<dt><code>all_filters_avail()</code></dt><dd><p>This function implements the HDF5-API function H5Pall_filters_avail.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_ALL_FILTERS_AVAIL'>https://portal.hdfgroup.org/display/HDF5/H5P_ALL_FILTERS_AVAIL</a> for details.</p></dd>
<dt><code>get_nfilters()</code></dt><dd><p>This function implements the HDF5-API function H5Pget_nfilters.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_NFILTERS'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_NFILTERS</a> for details.</p></dd>
<dt><code>get_filter(idx)</code></dt><dd><p>This function implements the HDF5-API function H5Pget_filter2.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILTER2'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILTER2</a> for details.</p></dd>
<dt><code>modify_filter(filter = h5const$H5Z_FILTER_DEFLATE,
flags = h5const$H5Z_FLAG_OPTIONAL, cd_values = integer(0))</code></dt><dd><p>This function implements the HDF5-API function H5Pmodify_filter.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_MODIFY_FILTER'>https://portal.hdfgroup.org/display/HDF5/H5P_MODIFY_FILTER</a> for details.</p></dd>
<dt><code>remove_filter(filter = h5const$H5Z_FILTER_ALL)</code></dt><dd><p>This function implements the HDF5-API function H5Premove_filter.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_REMOVE_FILTER'>https://portal.hdfgroup.org/display/HDF5/H5P_REMOVE_FILTER</a> for details.</p></dd>
<dt><code>set_fletcher32()</code></dt><dd><p>This function implements the HDF5-API function H5Pset_fletcher32.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_FLETCHER32'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_FLETCHER32</a> for details.</p></dd>
<dt><code>set_nbit()</code></dt><dd><p>This function implements the HDF5-API function H5Pset_nbit.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_NBIT'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_NBIT</a> for details.</p></dd>
<dt><code>set_scaleoffset(scale_type = h5const$H5Z_SO_FLOAT_DSCALE,
scale_factor = 0)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_scaleoffset.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_SCALEOFFSET'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_SCALEOFFSET</a> for details.</p></dd>
<dt><code>set_shuffle()</code></dt><dd><p>This function implements the HDF5-API function H5Pset_shuffle.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_SHUFFLE'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_SHUFFLE</a> for details.</p></dd>
<dt><code>set_szip()</code></dt><dd><p>This function implements the HDF5-API function H5Pset_szip.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_SZIP'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_SZIP</a> for details.</p></dd>
<dt><code>set_external(filename, offset, size)</code></dt><dd><p>This function implements the HDF5-API function H5Pset_external.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_SET_EXTERNAL'>https://portal.hdfgroup.org/display/HDF5/H5P_SET_EXTERNAL</a> for details.</p></dd>
<dt><code>get_external_count()</code></dt><dd><p>This function implements the HDF5-API function H5Pget_external_count.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_EXTERNAL_COUNT'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_EXTERNAL_COUNT</a> for details.</p></dd>
<dt><code>get_external(idx)</code></dt><dd><p>This function implements the HDF5-API function H5Pget_external.
Please see the documentation at <a href='https://portal.hdfgroup.org/display/HDF5/H5P_GET_EXTERNAL'>https://portal.hdfgroup.org/display/HDF5/H5P_GET_EXTERNAL</a> for details.</p></dd>
</dl>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p><code>H5P</code></p></div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#value">Value</a></li>
<li><a href="#methods">Methods</a></li>
<li><a href="#see-also">See also</a></li>
</ul>
<h2>Author</h2>
<p>Holger Hoefling</p>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Holger Hoefling, Mario Annau.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.9000.</p>
</div>
</footer>
</div>
</body>
</html>