-
Notifications
You must be signed in to change notification settings - Fork 25
/
structbigWigHdr__t.html
383 lines (345 loc) · 17.5 KB
/
structbigWigHdr__t.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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libBigWig: bigWigHdr_t Struct 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="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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libBigWig
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">bigWigHdr_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The header section of a bigWig file.
<a href="structbigWigHdr__t.html#details">More...</a></p>
<p><code>#include <<a class="el" href="bigWig_8h_source.html">bigWig.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ac0c3543680ec2b5b40015421788981a6"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#ac0c3543680ec2b5b40015421788981a6">version</a></td></tr>
<tr class="separator:ac0c3543680ec2b5b40015421788981a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad463547e38f7f36cd5d0c4a732c0b106"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#ad463547e38f7f36cd5d0c4a732c0b106">nLevels</a></td></tr>
<tr class="separator:ad463547e38f7f36cd5d0c4a732c0b106"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac14ee0aaf38f8fc719600f0fb19533f"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#aac14ee0aaf38f8fc719600f0fb19533f">ctOffset</a></td></tr>
<tr class="separator:aac14ee0aaf38f8fc719600f0fb19533f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd901706ed82b0c0cb8fdb43c231c952"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#acd901706ed82b0c0cb8fdb43c231c952">dataOffset</a></td></tr>
<tr class="separator:acd901706ed82b0c0cb8fdb43c231c952"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a933b1bc6988c30fca67bb392a04b7357"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a933b1bc6988c30fca67bb392a04b7357">indexOffset</a></td></tr>
<tr class="separator:a933b1bc6988c30fca67bb392a04b7357"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a837860f01747e54d36362e76611bf35b"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a837860f01747e54d36362e76611bf35b">fieldCount</a></td></tr>
<tr class="separator:a837860f01747e54d36362e76611bf35b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2751a957742e5f891032d1f96851f68c"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a2751a957742e5f891032d1f96851f68c">definedFieldCount</a></td></tr>
<tr class="separator:a2751a957742e5f891032d1f96851f68c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55105d4e1ad7e7a394e7858ee1693396"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a55105d4e1ad7e7a394e7858ee1693396">sqlOffset</a></td></tr>
<tr class="separator:a55105d4e1ad7e7a394e7858ee1693396"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8a93ded0aa0c125e9b140a9d3f12a2e"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#ad8a93ded0aa0c125e9b140a9d3f12a2e">summaryOffset</a></td></tr>
<tr class="separator:ad8a93ded0aa0c125e9b140a9d3f12a2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4b63611a0ec7f7f63fc7218bd35a2c0"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#af4b63611a0ec7f7f63fc7218bd35a2c0">bufSize</a></td></tr>
<tr class="separator:af4b63611a0ec7f7f63fc7218bd35a2c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e74411481d1ae2ff235cb7e98703e97"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a1e74411481d1ae2ff235cb7e98703e97">extensionOffset</a></td></tr>
<tr class="separator:a1e74411481d1ae2ff235cb7e98703e97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0faf3ffe182eb803cd4f98b6a0a8d69c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbwZoomHdr__t.html">bwZoomHdr_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a0faf3ffe182eb803cd4f98b6a0a8d69c">zoomHdrs</a></td></tr>
<tr class="separator:a0faf3ffe182eb803cd4f98b6a0a8d69c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0ab8ed38ed90d9efd36c8e00b45a061"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#ad0ab8ed38ed90d9efd36c8e00b45a061">nBasesCovered</a></td></tr>
<tr class="separator:ad0ab8ed38ed90d9efd36c8e00b45a061"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67b5de0ad0290fa5b43ef13856a3bc0a"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a67b5de0ad0290fa5b43ef13856a3bc0a">minVal</a></td></tr>
<tr class="separator:a67b5de0ad0290fa5b43ef13856a3bc0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff0c5d8df557a93e3b50f448992a3f71"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#aff0c5d8df557a93e3b50f448992a3f71">maxVal</a></td></tr>
<tr class="separator:aff0c5d8df557a93e3b50f448992a3f71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13a31d3a1bbd59122246d45f4ad2ae8b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#a13a31d3a1bbd59122246d45f4ad2ae8b">sumData</a></td></tr>
<tr class="separator:a13a31d3a1bbd59122246d45f4ad2ae8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb494d5a9908962b01c20aa27a5b7b50"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structbigWigHdr__t.html#adb494d5a9908962b01c20aa27a5b7b50">sumSquared</a></td></tr>
<tr class="separator:adb494d5a9908962b01c20aa27a5b7b50"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The header section of a bigWig file. </p>
<p>Some of the values aren't currently used for anything. Others may optionally not exist. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="af4b63611a0ec7f7f63fc7218bd35a2c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4b63611a0ec7f7f63fc7218bd35a2c0">◆ </a></span>bufSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bigWigHdr_t::bufSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>The compression buffer size (if the data is compressed). </p>
</div>
</div>
<a id="aac14ee0aaf38f8fc719600f0fb19533f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac14ee0aaf38f8fc719600f0fb19533f">◆ </a></span>ctOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bigWigHdr_t::ctOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The offset to the on-disk chromosome tree list. </p>
</div>
</div>
<a id="acd901706ed82b0c0cb8fdb43c231c952"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd901706ed82b0c0cb8fdb43c231c952">◆ </a></span>dataOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bigWigHdr_t::dataOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The on-disk offset to the first block of data. </p>
</div>
</div>
<a id="a2751a957742e5f891032d1f96851f68c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2751a957742e5f891032d1f96851f68c">◆ </a></span>definedFieldCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t bigWigHdr_t::definedFieldCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of fixed-format BED fields. </p>
</div>
</div>
<a id="a1e74411481d1ae2ff235cb7e98703e97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e74411481d1ae2ff235cb7e98703e97">◆ </a></span>extensionOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bigWigHdr_t::extensionOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unused </p>
</div>
</div>
<a id="a837860f01747e54d36362e76611bf35b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a837860f01747e54d36362e76611bf35b">◆ </a></span>fieldCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t bigWigHdr_t::fieldCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of fields. </p>
</div>
</div>
<a id="a933b1bc6988c30fca67bb392a04b7357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a933b1bc6988c30fca67bb392a04b7357">◆ </a></span>indexOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bigWigHdr_t::indexOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The on-disk offset to the data index. </p>
</div>
</div>
<a id="aff0c5d8df557a93e3b50f448992a3f71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff0c5d8df557a93e3b50f448992a3f71">◆ </a></span>maxVal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double bigWigHdr_t::maxVal</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum value in the file. </p>
</div>
</div>
<a id="a67b5de0ad0290fa5b43ef13856a3bc0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67b5de0ad0290fa5b43ef13856a3bc0a">◆ </a></span>minVal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double bigWigHdr_t::minVal</td>
</tr>
</table>
</div><div class="memdoc">
<p>The minimum value in the file. </p>
</div>
</div>
<a id="ad0ab8ed38ed90d9efd36c8e00b45a061"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0ab8ed38ed90d9efd36c8e00b45a061">◆ </a></span>nBasesCovered</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bigWigHdr_t::nBasesCovered</td>
</tr>
</table>
</div><div class="memdoc">
<p>The total bases covered in the file. </p>
</div>
</div>
<a id="ad463547e38f7f36cd5d0c4a732c0b106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad463547e38f7f36cd5d0c4a732c0b106">◆ </a></span>nLevels</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t bigWigHdr_t::nLevels</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of "zoom" levels. </p>
</div>
</div>
<a id="a55105d4e1ad7e7a394e7858ee1693396"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55105d4e1ad7e7a394e7858ee1693396">◆ </a></span>sqlOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bigWigHdr_t::sqlOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The on-disk offset to an SQL string. This is unused. </p>
</div>
</div>
<a id="a13a31d3a1bbd59122246d45f4ad2ae8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13a31d3a1bbd59122246d45f4ad2ae8b">◆ </a></span>sumData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double bigWigHdr_t::sumData</td>
</tr>
</table>
</div><div class="memdoc">
<p>The sum of all values in the file. </p>
</div>
</div>
<a id="ad8a93ded0aa0c125e9b140a9d3f12a2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8a93ded0aa0c125e9b140a9d3f12a2e">◆ </a></span>summaryOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bigWigHdr_t::summaryOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>If there's a summary, this is the offset to it on the disk. </p>
</div>
</div>
<a id="adb494d5a9908962b01c20aa27a5b7b50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb494d5a9908962b01c20aa27a5b7b50">◆ </a></span>sumSquared</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double bigWigHdr_t::sumSquared</td>
</tr>
</table>
</div><div class="memdoc">
<p>The sum of the squared values in the file. </p>
</div>
</div>
<a id="ac0c3543680ec2b5b40015421788981a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0c3543680ec2b5b40015421788981a6">◆ </a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t bigWigHdr_t::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>The version information of the file. </p>
</div>
</div>
<a id="a0faf3ffe182eb803cd4f98b6a0a8d69c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0faf3ffe182eb803cd4f98b6a0a8d69c">◆ </a></span>zoomHdrs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbwZoomHdr__t.html">bwZoomHdr_t</a>* bigWigHdr_t::zoomHdrs</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointers to the header for each zoom level. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bigWig_8h_source.html">bigWig.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 8 2020 13:48:36 for libBigWig by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>