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
|
<!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.8.9.1"/>
<title>OpenSlide: openslide.h Source File</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="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 style="padding-left: 0.5em;">
<div id="projectname">OpenSlide
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">openslide.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="openslide_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * OpenSlide, a library for reading whole slide image files</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2007-2014 Carnegie Mellon University</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * OpenSlide is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * published by the Free Software Foundation, version 2.1.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * OpenSlide is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * GNU Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * License along with OpenSlide. If not, see</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * <http://www.gnu.org/licenses/>.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifndef OPENSLIDE_OPENSLIDE_H_</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define OPENSLIDE_OPENSLIDE_H_</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "openslide-features.h"</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <stdint.h></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb"> 44</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>_openslide <a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> const <span class="keywordtype">char</span> *<a class="code" href="openslide_8h.html#a74235806da0623757d7e22a94bf9a88d">openslide_detect_vendor</a>(const <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *<a class="code" href="openslide_8h.html#a6d49bdccc0883d8cfc7d9e8085384b6d">openslide_open</a>(const <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> int32_t <a class="code" href="openslide_8h.html#a19eedd09aef2bd65db7e3b0a44e54738">openslide_get_level_count</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#ae075e78f69c4c443300fdcf36d019e82">openslide_get_level0_dimensions</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr, int64_t *w, int64_t *h);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#a5c9c95c21b0657ea9965ddb4fab7eda8">openslide_get_level_dimensions</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr, int32_t level,</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  int64_t *w, int64_t *h);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">double</span> <a class="code" href="openslide_8h.html#a60daced5880dc3e4cf428dd81ba67bee">openslide_get_level_downsample</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr, int32_t level);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> int32_t <a class="code" href="openslide_8h.html#ac8a91866597157a270b8f8434cb4d7fc">openslide_get_best_level_for_downsample</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr,</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">double</span> downsample);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#a0eeecec682efdf2ef18c8426109acad0">openslide_read_region</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr,</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  uint32_t *dest,</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  int64_t x, int64_t y,</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  int32_t level,</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  int64_t w, int64_t h);</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#a3a69dfe81462a4e90c8da78d1addc4bd">openslide_close</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr);</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> const <span class="keywordtype">char</span> *<a class="code" href="openslide_8h.html#a130ff0793d57ecc5649ca7fff1fc005c">openslide_get_error</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr);</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a name="l00247"></a><span class="lineno"><a class="line" href="openslide_8h.html#acab4512e53b74cb5b70b652fa322236e"> 247</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_COMMENT "openslide.comment"</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div>
<div class="line"><a name="l00252"></a><span class="lineno"><a class="line" href="openslide_8h.html#a0fd5ca3fa8167972fb4344906928928c"> 252</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_VENDOR "openslide.vendor"</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div>
<div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="openslide_8h.html#aa280780085714cf37802d8da311885de"> 257</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_QUICKHASH1 "openslide.quickhash-1"</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div>
<div class="line"><a name="l00265"></a><span class="lineno"><a class="line" href="openslide_8h.html#a9ab13d8e8d8e56334ab0bbad35c4cdb6"> 265</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_BACKGROUND_COLOR "openslide.background-color"</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> </div>
<div class="line"><a name="l00272"></a><span class="lineno"><a class="line" href="openslide_8h.html#abca4825eafbf7d0098fa6d87e9435e75"> 272</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_OBJECTIVE_POWER "openslide.objective-power"</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div>
<div class="line"><a name="l00280"></a><span class="lineno"><a class="line" href="openslide_8h.html#af0a3b3bf078d123379e3343e03ad4991"> 280</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_MPP_X "openslide.mpp-x"</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> </div>
<div class="line"><a name="l00288"></a><span class="lineno"><a class="line" href="openslide_8h.html#a427734d2c8edece7a5f0a394175d524f"> 288</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_MPP_Y "openslide.mpp-y"</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div>
<div class="line"><a name="l00296"></a><span class="lineno"><a class="line" href="openslide_8h.html#a1a1a367a8f5a2c7024d117c2e12e0cb3"> 296</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_BOUNDS_X "openslide.bounds-x"</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div>
<div class="line"><a name="l00304"></a><span class="lineno"><a class="line" href="openslide_8h.html#a93a17952a08d69bd83970ba40ef6f077"> 304</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_BOUNDS_Y "openslide.bounds-y"</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div>
<div class="line"><a name="l00312"></a><span class="lineno"><a class="line" href="openslide_8h.html#ab6e3d883aaef3476c493d9ffe2b78bfc"> 312</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_BOUNDS_WIDTH "openslide.bounds-width"</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> </div>
<div class="line"><a name="l00320"></a><span class="lineno"><a class="line" href="openslide_8h.html#a82b5a752ebb4a06af09afc2878b82f10"> 320</a></span> <span class="preprocessor">#define OPENSLIDE_PROPERTY_NAME_BOUNDS_HEIGHT "openslide.bounds-height"</span></div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> </div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> const <span class="keywordtype">char</span> * const *<a class="code" href="openslide_8h.html#a8dc4d1da342d1892bb011d97bd0c22b0">openslide_get_property_names</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr);</div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> </div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> </div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> const <span class="keywordtype">char</span> *<a class="code" href="openslide_8h.html#ab2a142492c7fd39c88669ef7864f072f">openslide_get_property_value</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr, const <span class="keywordtype">char</span> *name);</div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> </div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> </div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> </div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> const <span class="keywordtype">char</span> * const *<a class="code" href="openslide_8h.html#af6400c16cf1a94557f013f301ee2ea4d">openslide_get_associated_image_names</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr);</div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> </div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#a2d1bca93ff5cbd2e13c4e6aaec868fd1">openslide_get_associated_image_dimensions</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr,</div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  const <span class="keywordtype">char</span> *name,</div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  int64_t *w, int64_t *h);</div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> </div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> </div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#a71ace07f87c9aeab328d3a6efcd2f983">openslide_read_associated_image</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr,</div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  const <span class="keywordtype">char</span> *name,</div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  uint32_t *dest);</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> </div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> </div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> const <span class="keywordtype">char</span> *<a class="code" href="openslide_8h.html#a9a951e02b283b66187591ea09e8f82b2">openslide_get_version</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> </div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> </div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> </div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> OPENSLIDE_DEPRECATED_FOR(<a class="code" href="openslide_8h.html#a74235806da0623757d7e22a94bf9a88d">openslide_detect_vendor</a> or <a class="code" href="openslide_8h.html#a6d49bdccc0883d8cfc7d9e8085384b6d">openslide_open</a>)</div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="keywordtype">bool</span> <a class="code" href="openslide_8h.html#af3aad60d3b901dd9a6d1278a52b1105d">openslide_can_open</a>(const <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> </div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> </div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> OPENSLIDE_DEPRECATED_FOR(<a class="code" href="openslide_8h.html#a19eedd09aef2bd65db7e3b0a44e54738">openslide_get_level_count</a>)</div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> int32_t <a class="code" href="openslide_8h.html#a504f741f8bc17e0ecac563f2f1125509">openslide_get_layer_count</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr);</div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> </div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> </div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> OPENSLIDE_DEPRECATED_FOR(<a class="code" href="openslide_8h.html#ae075e78f69c4c443300fdcf36d019e82">openslide_get_level0_dimensions</a>)</div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#a01ace929808942ca6c62218dea7eb2e6">openslide_get_layer0_dimensions</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr, int64_t *w, int64_t *h);</div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> </div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> </div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> OPENSLIDE_DEPRECATED_FOR(<a class="code" href="openslide_8h.html#a5c9c95c21b0657ea9965ddb4fab7eda8">openslide_get_level_dimensions</a>)</div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="keywordtype">void</span> <a class="code" href="openslide_8h.html#ab02f7110b02c6aeb9646e83646035f00">openslide_get_layer_dimensions</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr, int32_t level,</div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  int64_t *w, int64_t *h);</div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> </div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> </div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> OPENSLIDE_DEPRECATED_FOR(<a class="code" href="openslide_8h.html#a60daced5880dc3e4cf428dd81ba67bee">openslide_get_level_downsample</a>)</div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="keywordtype">double</span> <a class="code" href="openslide_8h.html#a88b7d2ecc8606c0673c3c49485f075d2">openslide_get_layer_downsample</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr, int32_t level);</div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> </div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> </div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> OPENSLIDE_DEPRECATED_FOR(<a class="code" href="openslide_8h.html#ac8a91866597157a270b8f8434cb4d7fc">openslide_get_best_level_for_downsample</a>)</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> int32_t <a class="code" href="openslide_8h.html#ad2dfde287c3c84eb5a2e5e7bab3848d9">openslide_get_best_layer_for_downsample</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr,</div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  <span class="keywordtype">double</span> downsample);</div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> </div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> OPENSLIDE_PUBLIC()</div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> OPENSLIDE_DEPRECATED_FOR(<a class="code" href="openslide_8h.html#ab2a142492c7fd39c88669ef7864f072f">openslide_get_property_value</a>(osr, <a class="code" href="openslide_8h.html#acab4512e53b74cb5b70b652fa322236e">OPENSLIDE_PROPERTY_NAME_COMMENT</a>))</div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> const <span class="keywordtype">char</span> *<a class="code" href="openslide_8h.html#aab7aae3dc615a1f33f359bb93d02ab41">openslide_get_comment</a>(<a class="code" href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a> *osr);</div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> </div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> </div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="preprocessor">#ifndef OPENSLIDE_SIMPLIFY_HEADERS</span></div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment">// these are meant to throw compile- and link-time errors,</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment">// since the functions they replace were never implemented</span></div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="keywordtype">int</span> _openslide_give_prefetch_hint_UNIMPLEMENTED(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="keywordtype">void</span> _openslide_cancel_prefetch_hint_UNIMPLEMENTED(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="preprocessor">#define openslide_give_prefetch_hint(osr, x, y, level, w, h) \</span></div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="preprocessor"> _openslide_give_prefetch_hint_UNIMPLEMENTED(-1);</span></div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="preprocessor">#define openslide_cancel_prefetch_hint(osr, prefetch_id) \</span></div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="preprocessor"> _openslide_cancel_prefetch_hint_UNIMPLEMENTED(-1)</span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> </div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span> }</div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> </div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="openslide_8h_html_ad2dfde287c3c84eb5a2e5e7bab3848d9"><div class="ttname"><a href="openslide_8h.html#ad2dfde287c3c84eb5a2e5e7bab3848d9">openslide_get_best_layer_for_downsample</a></div><div class="ttdeci">int32_t openslide_get_best_layer_for_downsample(openslide_t *osr, double downsample)</div><div class="ttdoc">Get the best level to use for displaying the given downsample. </div></div>
<div class="ttc" id="openslide_8h_html_ac8a91866597157a270b8f8434cb4d7fc"><div class="ttname"><a href="openslide_8h.html#ac8a91866597157a270b8f8434cb4d7fc">openslide_get_best_level_for_downsample</a></div><div class="ttdeci">int32_t openslide_get_best_level_for_downsample(openslide_t *osr, double downsample)</div><div class="ttdoc">Get the best level to use for displaying the given downsample. </div></div>
<div class="ttc" id="openslide_8h_html_ab2a142492c7fd39c88669ef7864f072f"><div class="ttname"><a href="openslide_8h.html#ab2a142492c7fd39c88669ef7864f072f">openslide_get_property_value</a></div><div class="ttdeci">const char * openslide_get_property_value(openslide_t *osr, const char *name)</div><div class="ttdoc">Get the value of a single property. </div></div>
<div class="ttc" id="openslide_8h_html_aab7aae3dc615a1f33f359bb93d02ab41"><div class="ttname"><a href="openslide_8h.html#aab7aae3dc615a1f33f359bb93d02ab41">openslide_get_comment</a></div><div class="ttdeci">const char * openslide_get_comment(openslide_t *osr)</div><div class="ttdoc">Get the comment (if any) for this image. </div></div>
<div class="ttc" id="openslide_8h_html_a01ace929808942ca6c62218dea7eb2e6"><div class="ttname"><a href="openslide_8h.html#a01ace929808942ca6c62218dea7eb2e6">openslide_get_layer0_dimensions</a></div><div class="ttdeci">void openslide_get_layer0_dimensions(openslide_t *osr, int64_t *w, int64_t *h)</div><div class="ttdoc">Get the dimensions of level 0 (the largest level). </div></div>
<div class="ttc" id="openslide_8h_html_a990dde8d8caba731de6a9c8895df41cb"><div class="ttname"><a href="openslide_8h.html#a990dde8d8caba731de6a9c8895df41cb">openslide_t</a></div><div class="ttdeci">struct _openslide openslide_t</div><div class="ttdoc">The main OpenSlide type. </div><div class="ttdef"><b>Definition:</b> openslide.h:44</div></div>
<div class="ttc" id="openslide_8h_html_acab4512e53b74cb5b70b652fa322236e"><div class="ttname"><a href="openslide_8h.html#acab4512e53b74cb5b70b652fa322236e">OPENSLIDE_PROPERTY_NAME_COMMENT</a></div><div class="ttdeci">#define OPENSLIDE_PROPERTY_NAME_COMMENT</div><div class="ttdoc">The name of the property containing a slide's comment, if any. </div><div class="ttdef"><b>Definition:</b> openslide.h:247</div></div>
<div class="ttc" id="openslide_8h_html_a130ff0793d57ecc5649ca7fff1fc005c"><div class="ttname"><a href="openslide_8h.html#a130ff0793d57ecc5649ca7fff1fc005c">openslide_get_error</a></div><div class="ttdeci">const char * openslide_get_error(openslide_t *osr)</div><div class="ttdoc">Get the current error string. </div></div>
<div class="ttc" id="openslide_8h_html_a71ace07f87c9aeab328d3a6efcd2f983"><div class="ttname"><a href="openslide_8h.html#a71ace07f87c9aeab328d3a6efcd2f983">openslide_read_associated_image</a></div><div class="ttdeci">void openslide_read_associated_image(openslide_t *osr, const char *name, uint32_t *dest)</div><div class="ttdoc">Copy pre-multiplied ARGB data from an associated image. </div></div>
<div class="ttc" id="openslide_8h_html_a0eeecec682efdf2ef18c8426109acad0"><div class="ttname"><a href="openslide_8h.html#a0eeecec682efdf2ef18c8426109acad0">openslide_read_region</a></div><div class="ttdeci">void openslide_read_region(openslide_t *osr, uint32_t *dest, int64_t x, int64_t y, int32_t level, int64_t w, int64_t h)</div><div class="ttdoc">Copy pre-multiplied ARGB data from a whole slide image. </div></div>
<div class="ttc" id="openslide_8h_html_af3aad60d3b901dd9a6d1278a52b1105d"><div class="ttname"><a href="openslide_8h.html#af3aad60d3b901dd9a6d1278a52b1105d">openslide_can_open</a></div><div class="ttdeci">bool openslide_can_open(const char *filename)</div><div class="ttdoc">Return whether openslide_open() will succeed. </div></div>
<div class="ttc" id="openslide_8h_html_a504f741f8bc17e0ecac563f2f1125509"><div class="ttname"><a href="openslide_8h.html#a504f741f8bc17e0ecac563f2f1125509">openslide_get_layer_count</a></div><div class="ttdeci">int32_t openslide_get_layer_count(openslide_t *osr)</div><div class="ttdoc">Get the number of levels in the whole slide image. </div></div>
<div class="ttc" id="openslide_8h_html_a74235806da0623757d7e22a94bf9a88d"><div class="ttname"><a href="openslide_8h.html#a74235806da0623757d7e22a94bf9a88d">openslide_detect_vendor</a></div><div class="ttdeci">const char * openslide_detect_vendor(const char *filename)</div><div class="ttdoc">Quickly determine whether a whole slide image is recognized. </div></div>
<div class="ttc" id="openslide_8h_html_af6400c16cf1a94557f013f301ee2ea4d"><div class="ttname"><a href="openslide_8h.html#af6400c16cf1a94557f013f301ee2ea4d">openslide_get_associated_image_names</a></div><div class="ttdeci">const char *const * openslide_get_associated_image_names(openslide_t *osr)</div><div class="ttdoc">Get the NULL-terminated array of associated image names. </div></div>
<div class="ttc" id="openslide_8h_html_a5c9c95c21b0657ea9965ddb4fab7eda8"><div class="ttname"><a href="openslide_8h.html#a5c9c95c21b0657ea9965ddb4fab7eda8">openslide_get_level_dimensions</a></div><div class="ttdeci">void openslide_get_level_dimensions(openslide_t *osr, int32_t level, int64_t *w, int64_t *h)</div><div class="ttdoc">Get the dimensions of a level. </div></div>
<div class="ttc" id="openslide_8h_html_ab02f7110b02c6aeb9646e83646035f00"><div class="ttname"><a href="openslide_8h.html#ab02f7110b02c6aeb9646e83646035f00">openslide_get_layer_dimensions</a></div><div class="ttdeci">void openslide_get_layer_dimensions(openslide_t *osr, int32_t level, int64_t *w, int64_t *h)</div><div class="ttdoc">Get the dimensions of a level. </div></div>
<div class="ttc" id="openslide_8h_html_ae075e78f69c4c443300fdcf36d019e82"><div class="ttname"><a href="openslide_8h.html#ae075e78f69c4c443300fdcf36d019e82">openslide_get_level0_dimensions</a></div><div class="ttdeci">void openslide_get_level0_dimensions(openslide_t *osr, int64_t *w, int64_t *h)</div><div class="ttdoc">Get the dimensions of level 0 (the largest level). </div></div>
<div class="ttc" id="openslide_8h_html_a60daced5880dc3e4cf428dd81ba67bee"><div class="ttname"><a href="openslide_8h.html#a60daced5880dc3e4cf428dd81ba67bee">openslide_get_level_downsample</a></div><div class="ttdeci">double openslide_get_level_downsample(openslide_t *osr, int32_t level)</div><div class="ttdoc">Get the downsampling factor of a given level. </div></div>
<div class="ttc" id="openslide_8h_html_a9a951e02b283b66187591ea09e8f82b2"><div class="ttname"><a href="openslide_8h.html#a9a951e02b283b66187591ea09e8f82b2">openslide_get_version</a></div><div class="ttdeci">const char * openslide_get_version(void)</div><div class="ttdoc">Get the version of the OpenSlide library. </div></div>
<div class="ttc" id="openslide_8h_html_a19eedd09aef2bd65db7e3b0a44e54738"><div class="ttname"><a href="openslide_8h.html#a19eedd09aef2bd65db7e3b0a44e54738">openslide_get_level_count</a></div><div class="ttdeci">int32_t openslide_get_level_count(openslide_t *osr)</div><div class="ttdoc">Get the number of levels in the whole slide image. </div></div>
<div class="ttc" id="openslide_8h_html_a6d49bdccc0883d8cfc7d9e8085384b6d"><div class="ttname"><a href="openslide_8h.html#a6d49bdccc0883d8cfc7d9e8085384b6d">openslide_open</a></div><div class="ttdeci">openslide_t * openslide_open(const char *filename)</div><div class="ttdoc">Open a whole slide image. </div></div>
<div class="ttc" id="openslide_8h_html_a8dc4d1da342d1892bb011d97bd0c22b0"><div class="ttname"><a href="openslide_8h.html#a8dc4d1da342d1892bb011d97bd0c22b0">openslide_get_property_names</a></div><div class="ttdeci">const char *const * openslide_get_property_names(openslide_t *osr)</div><div class="ttdoc">Get the NULL-terminated array of property names. </div></div>
<div class="ttc" id="openslide_8h_html_a2d1bca93ff5cbd2e13c4e6aaec868fd1"><div class="ttname"><a href="openslide_8h.html#a2d1bca93ff5cbd2e13c4e6aaec868fd1">openslide_get_associated_image_dimensions</a></div><div class="ttdeci">void openslide_get_associated_image_dimensions(openslide_t *osr, const char *name, int64_t *w, int64_t *h)</div><div class="ttdoc">Get the dimensions of an associated image. </div></div>
<div class="ttc" id="openslide_8h_html_a3a69dfe81462a4e90c8da78d1addc4bd"><div class="ttname"><a href="openslide_8h.html#a3a69dfe81462a4e90c8da78d1addc4bd">openslide_close</a></div><div class="ttdeci">void openslide_close(openslide_t *osr)</div><div class="ttdoc">Close an OpenSlide object. </div></div>
<div class="ttc" id="openslide_8h_html_a88b7d2ecc8606c0673c3c49485f075d2"><div class="ttname"><a href="openslide_8h.html#a88b7d2ecc8606c0673c3c49485f075d2">openslide_get_layer_downsample</a></div><div class="ttdeci">double openslide_get_layer_downsample(openslide_t *osr, int32_t level)</div><div class="ttdoc">Get the downsampling factor of a given level. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
|
