forked from openslide/openslide.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
757 lines (705 loc) · 87.6 KB
/
index.html
File metadata and controls
757 lines (705 loc) · 87.6 KB
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>OpenSlide Python — OpenSlide Python 1.4.3 documentation</title>
<link rel="stylesheet" type="text/css" href="static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="static/classic.css?v=f11ead97" />
<script src="static/documentation_options.js?v=a68a9277"></script>
<script src="static/doctools.js?v=fd6eb6e6"></script>
<script src="static/sphinx_highlight.js?v=6ffebe34"></script>
<link rel="search" title="Search" href="search.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="#">OpenSlide Python 1.4.3 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">OpenSlide Python</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="openslide-python">
<h1>OpenSlide Python<a class="headerlink" href="#openslide-python" title="Link to this heading">¶</a></h1>
<p>OpenSlide Python is a Python interface to the <a class="reference external" href="https://openslide.org/">OpenSlide</a> library.</p>
<p>OpenSlide is a C library that provides a simple interface for reading
whole-slide images, also known as virtual slides, which are high-resolution
images used in digital pathology. These images can occupy tens of gigabytes
when uncompressed, and so cannot be easily read using standard tools or
libraries, which are designed for images that can be comfortably
uncompressed into RAM. Whole-slide images are typically multi-resolution;
OpenSlide allows reading a small amount of image data at the resolution
closest to a desired zoom level.</p>
<p>OpenSlide can read virtual slides in several formats:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://openslide.org/formats/aperio/">Aperio</a> (<code class="docutils literal notranslate"><span class="pre">.svs</span></code>, <code class="docutils literal notranslate"><span class="pre">.tif</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/dicom/">DICOM</a> (<code class="docutils literal notranslate"><span class="pre">.dcm</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/hamamatsu/">Hamamatsu</a> (<code class="docutils literal notranslate"><span class="pre">.ndpi</span></code>, <code class="docutils literal notranslate"><span class="pre">.vms</span></code>, <code class="docutils literal notranslate"><span class="pre">.vmu</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/leica/">Leica</a> (<code class="docutils literal notranslate"><span class="pre">.scn</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/mirax/">MIRAX</a> (<code class="docutils literal notranslate"><span class="pre">.mrxs</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/philips/">Philips</a> (<code class="docutils literal notranslate"><span class="pre">.tiff</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/sakura/">Sakura</a> (<code class="docutils literal notranslate"><span class="pre">.svslide</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/trestle/">Trestle</a> (<code class="docutils literal notranslate"><span class="pre">.tif</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/ventana/">Ventana</a> (<code class="docutils literal notranslate"><span class="pre">.bif</span></code>, <code class="docutils literal notranslate"><span class="pre">.tif</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/zeiss/">Zeiss</a> (<code class="docutils literal notranslate"><span class="pre">.czi</span></code>)</p></li>
<li><p><a class="reference external" href="https://openslide.org/formats/generic-tiff/">Generic tiled TIFF</a> (<code class="docutils literal notranslate"><span class="pre">.tif</span></code>)</p></li>
</ul>
<p>OpenSlide Python is released under the terms of the <a class="reference external" href="https://openslide.org/license/">GNU Lesser General
Public License, version 2.1</a>.</p>
<section id="installing">
<h2>Installing<a class="headerlink" href="#installing" title="Link to this heading">¶</a></h2>
<p>OpenSlide Python requires <a class="reference external" href="https://openslide.org/">OpenSlide</a>, which must be installed separately.
If you intend to use OpenSlide only with Python, the easiest way to get it
is to install the <a class="reference external" href="https://pypi.org/project/openslide-bin/">openslide-bin</a> Python package with
<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">openslide-bin</span></code>.</p>
<p>On Linux and macOS, you can also <a class="reference external" href="https://openslide.org/download/#distribution-packages">install</a> both OpenSlide and OpenSlide
Python with a package manager that packages both, such as <a class="reference external" href="https://anaconda.org/">Anaconda</a>, DNF or
Apt on Linux systems, or <a class="reference external" href="https://www.macports.org/">MacPorts</a> on macOS systems. Or, you can install
OpenSlide Python with <a class="reference external" href="https://pip.pypa.io/en/stable/">pip</a> after installing OpenSlide with a package manager
or from <a class="reference external" href="https://openslide.org/download/#source">source</a>. Except for pip, do not mix OpenSlide and OpenSlide Python
from different package managers (for example, OpenSlide from MacPorts and
OpenSlide Python from Anaconda), since you’ll get library conflicts.</p>
<p>On Windows, you can also download the OpenSlide <a class="reference external" href="https://openslide.org/download/#binaries">Windows binaries</a> and
extract them to a known path. Then, import <code class="docutils literal notranslate"><span class="pre">openslide</span></code> inside a
<code class="docutils literal notranslate"><span class="pre">with</span> <span class="pre">os.add_dll_directory()</span></code> statement:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># The path can also be read from a config file, etc.</span>
<span class="n">OPENSLIDE_PATH</span> <span class="o">=</span> <span class="sa">r</span><span class="s1">'c:\path\to\openslide-win64\bin'</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">os</span><span class="p">,</span> <span class="s1">'add_dll_directory'</span><span class="p">):</span>
<span class="c1"># Windows</span>
<span class="k">with</span> <span class="n">os</span><span class="o">.</span><span class="n">add_dll_directory</span><span class="p">(</span><span class="n">OPENSLIDE_PATH</span><span class="p">):</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">openslide</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">openslide</span>
</pre></div>
</div>
</section>
<section id="basic-usage">
<h2>Basic usage<a class="headerlink" href="#basic-usage" title="Link to this heading">¶</a></h2>
<section id="module-openslide">
<span id="openslide-objects"></span><h3>OpenSlide objects<a class="headerlink" href="#module-openslide" title="Link to this heading">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="openslide.OpenSlide">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">OpenSlide</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/os.html#os.PathLike" title="(in Python v3.14)"><span class="pre">PathLike</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openslide.OpenSlide" title="Link to this definition">¶</a></dt>
<dd><p>An open whole-slide image.</p>
<p>If any operation on the object fails, <a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a> is raised.
OpenSlide has latching error semantics: once <a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a> is
raised, all future operations on the <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a>, other than
<a class="reference internal" href="#openslide.OpenSlide.close" title="openslide.OpenSlide.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a>, will also raise <a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a>.</p>
<p><a class="reference internal" href="#openslide.OpenSlide.close" title="openslide.OpenSlide.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> is called automatically when the object is deleted.
The object may be used as a context manager, in which case it will be
closed upon exiting the context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filename</strong> – the file to open</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference internal" href="#openslide.OpenSlideUnsupportedFormatError" title="openslide.OpenSlideUnsupportedFormatError"><strong>OpenSlideUnsupportedFormatError</strong></a> – if the file is not recognized by
OpenSlide</p></li>
<li><p><a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><strong>OpenSlideError</strong></a> – if the file is recognized but an error occurred</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.OpenSlide.detect_format">
<span class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">detect_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/os.html#os.PathLike" title="(in Python v3.14)"><span class="pre">PathLike</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#openslide.OpenSlide.detect_format" title="Link to this definition">¶</a></dt>
<dd><p>Return a string describing the format vendor of the specified file.
This string is also accessible via the <a class="reference internal" href="#openslide.PROPERTY_NAME_VENDOR" title="openslide.PROPERTY_NAME_VENDOR"><code class="xref py py-data docutils literal notranslate"><span class="pre">PROPERTY_NAME_VENDOR</span></code></a>
property.</p>
<p>If the file is not recognized, return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filename</strong> – the file to examine</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.OpenSlide.level_count">
<span class="sig-name descname"><span class="pre">level_count</span></span><a class="headerlink" href="#openslide.OpenSlide.level_count" title="Link to this definition">¶</a></dt>
<dd><p>The number of levels in the slide. Levels are numbered from <code class="docutils literal notranslate"><span class="pre">0</span></code>
(highest resolution) to <code class="docutils literal notranslate"><span class="pre">level_count</span> <span class="pre">-</span> <span class="pre">1</span></code> (lowest resolution).</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.OpenSlide.dimensions">
<span class="sig-name descname"><span class="pre">dimensions</span></span><a class="headerlink" href="#openslide.OpenSlide.dimensions" title="Link to this definition">¶</a></dt>
<dd><p>A <code class="docutils literal notranslate"><span class="pre">(width,</span> <span class="pre">height)</span></code> tuple for level 0 of the slide.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.OpenSlide.level_dimensions">
<span class="sig-name descname"><span class="pre">level_dimensions</span></span><a class="headerlink" href="#openslide.OpenSlide.level_dimensions" title="Link to this definition">¶</a></dt>
<dd><p>A tuple of <code class="docutils literal notranslate"><span class="pre">(width,</span> <span class="pre">height)</span></code> tuples, one for each level of the slide.
<code class="docutils literal notranslate"><span class="pre">level_dimensions[k]</span></code> are the dimensions of level <code class="docutils literal notranslate"><span class="pre">k</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>], …]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.OpenSlide.level_downsamples">
<span class="sig-name descname"><span class="pre">level_downsamples</span></span><a class="headerlink" href="#openslide.OpenSlide.level_downsamples" title="Link to this definition">¶</a></dt>
<dd><p>A tuple of downsample factors for each level of the slide.
<code class="docutils literal notranslate"><span class="pre">level_downsamples[k]</span></code> is the downsample factor of level <code class="docutils literal notranslate"><span class="pre">k</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)">float</a>, …]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.OpenSlide.properties">
<span class="sig-name descname"><span class="pre">properties</span></span><a class="headerlink" href="#openslide.OpenSlide.properties" title="Link to this definition">¶</a></dt>
<dd><p>Metadata about the slide, in the form of a
<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code></a> from OpenSlide property name to
property value. OpenSlide provides some <a class="reference internal" href="#standard-properties"><span class="std std-ref">Standard properties</span></a>,
plus additional properties that vary by slide format.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.14)"><em>Mapping</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.OpenSlide.associated_images">
<span class="sig-name descname"><span class="pre">associated_images</span></span><a class="headerlink" href="#openslide.OpenSlide.associated_images" title="Link to this definition">¶</a></dt>
<dd><p>Images, such as label or macro images, which are associated with this
slide. This is a <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code></a> from image
name to RGBA <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a>.</p>
<p>Unlike in the C interface, these images are not premultiplied.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.14)"><em>Mapping</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a>, <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><em>Image</em></a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.OpenSlide.color_profile">
<span class="sig-name descname"><span class="pre">color_profile</span></span><a class="headerlink" href="#openslide.OpenSlide.color_profile" title="Link to this definition">¶</a></dt>
<dd><p>The embedded <a class="reference internal" href="#color-management"><span class="std std-ref">color profile</span></a> for this slide,
or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> if not available.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/ImageCms.html#PIL.ImageCms.ImageCmsProfile" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><em>ImageCmsProfile</em></a> | None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.OpenSlide.read_region">
<span class="sig-name descname"><span class="pre">read_region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><span class="pre">Image</span></a></span></span><a class="headerlink" href="#openslide.OpenSlide.read_region" title="Link to this definition">¶</a></dt>
<dd><p>Return an RGBA <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a> containing the contents of
the specified region.</p>
<p>Unlike in the C interface, the image data is not premultiplied.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>location</strong> – <code class="docutils literal notranslate"><span class="pre">(x,</span> <span class="pre">y)</span></code> tuple giving the top left pixel in the
level 0 reference frame</p></li>
<li><p><strong>level</strong> – the level number</p></li>
<li><p><strong>size</strong> – <code class="docutils literal notranslate"><span class="pre">(width,</span> <span class="pre">height)</span></code> tuple giving the region size</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.OpenSlide.get_best_level_for_downsample">
<span class="sig-name descname"><span class="pre">get_best_level_for_downsample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">downsample</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><span class="pre">float</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#openslide.OpenSlide.get_best_level_for_downsample" title="Link to this definition">¶</a></dt>
<dd><p>Return the best level for displaying the given downsample.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>downsample</strong> – the desired downsample factor</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.OpenSlide.get_thumbnail">
<span class="sig-name descname"><span class="pre">get_thumbnail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><span class="pre">Image</span></a></span></span><a class="headerlink" href="#openslide.OpenSlide.get_thumbnail" title="Link to this definition">¶</a></dt>
<dd><p>Return an <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a> containing an RGB thumbnail of the
slide.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>size</strong> – the maximum size of the thumbnail as a <code class="docutils literal notranslate"><span class="pre">(width,</span> <span class="pre">height)</span></code>
tuple</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.OpenSlide.set_cache">
<span class="sig-name descname"><span class="pre">set_cache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cache</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openslide.OpenSlideCache" title="openslide.OpenSlideCache"><span class="pre">OpenSlideCache</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#openslide.OpenSlide.set_cache" title="Link to this definition">¶</a></dt>
<dd><p>Use the specified <a class="reference internal" href="#openslide.OpenSlideCache" title="openslide.OpenSlideCache"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlideCache</span></code></a> to store recently decoded
slide tiles. By default, the <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a> has a private cache
with a default size.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cache</strong> – a cache object</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#openslide.OpenSlideVersionError" title="openslide.OpenSlideVersionError"><strong>OpenSlideVersionError</strong></a> – if OpenSlide is older than version 4.0.0</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.OpenSlide.close">
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#openslide.OpenSlide.close" title="Link to this definition">¶</a></dt>
<dd><p>Close the OpenSlide object.</p>
</dd></dl>
</dd></dl>
</section>
<section id="color-management">
<span id="id1"></span><h3>Color management<a class="headerlink" href="#color-management" title="Link to this heading">¶</a></h3>
<p>Every slide region, associated image, thumbnail, and Deep Zoom tile produced
by OpenSlide Python includes a reference to an ICC color profile whenever a
profile is available for the underlying pixel data. Profiles are stored as
a <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object in
<a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image.info" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Image.info</span></code></a><code class="xref py py-attr docutils literal notranslate"><span class="pre">['icc_profile']</span></code>. If no
profile is available, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">icc_profile</span></code> dictionary key is absent.</p>
<p>To include the profile in an image file when saving the image to disk:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">image</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">icc_profile</span><span class="o">=</span><span class="n">image</span><span class="o">.</span><span class="n">info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'icc_profile'</span><span class="p">))</span>
</pre></div>
</div>
<p>To perform color conversions using the profile, import it into
<a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/ImageCms.html#module-PIL.ImageCms" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ImageCms</span></code></a>. For example, to synthesize an sRGB profile
and use it to transform an image for display, with the default rendering
intent of the image’s profile:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">io</span><span class="w"> </span><span class="kn">import</span> <span class="n">BytesIO</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">PIL</span><span class="w"> </span><span class="kn">import</span> <span class="n">ImageCms</span>
<span class="n">fromProfile</span> <span class="o">=</span> <span class="n">ImageCms</span><span class="o">.</span><span class="n">getOpenProfile</span><span class="p">(</span><span class="n">BytesIO</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s1">'icc_profile'</span><span class="p">]))</span>
<span class="n">toProfile</span> <span class="o">=</span> <span class="n">ImageCms</span><span class="o">.</span><span class="n">createProfile</span><span class="p">(</span><span class="s1">'sRGB'</span><span class="p">)</span>
<span class="n">intent</span> <span class="o">=</span> <span class="n">ImageCms</span><span class="o">.</span><span class="n">getDefaultIntent</span><span class="p">(</span><span class="n">fromProfile</span><span class="p">)</span>
<span class="n">ImageCms</span><span class="o">.</span><span class="n">profileToProfile</span><span class="p">(</span>
<span class="n">image</span><span class="p">,</span> <span class="n">fromProfile</span><span class="p">,</span> <span class="n">toProfile</span><span class="p">,</span> <span class="n">intent</span><span class="p">,</span> <span class="s1">'RGBA'</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="mi">0</span>
<span class="p">)</span>
</pre></div>
</div>
<p>When converting Deep Zoom tiles, use <code class="docutils literal notranslate"><span class="pre">'RGB'</span></code> instead of <code class="docutils literal notranslate"><span class="pre">'RGBA'</span></code>.</p>
<p>All pyramid regions in a slide have the same profile, but each associated
image can have its own profile. As a convenience, the former is also
available as <a class="reference internal" href="#openslide.OpenSlide.color_profile" title="openslide.OpenSlide.color_profile"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OpenSlide.color_profile</span></code></a>, already parsed into an
<a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/ImageCms.html#PIL.ImageCms.ImageCmsProfile" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageCmsProfile</span></code></a> object. You can save processing time
by building an <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/ImageCms.html#PIL.ImageCms.ImageCmsTransform" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageCmsTransform</span></code></a> for the slide and
reusing it for multiple slide regions:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">toProfile</span> <span class="o">=</span> <span class="n">ImageCms</span><span class="o">.</span><span class="n">createProfile</span><span class="p">(</span><span class="s1">'sRGB'</span><span class="p">)</span>
<span class="n">intent</span> <span class="o">=</span> <span class="n">ImageCms</span><span class="o">.</span><span class="n">getDefaultIntent</span><span class="p">(</span><span class="n">slide</span><span class="o">.</span><span class="n">color_profile</span><span class="p">)</span>
<span class="n">transform</span> <span class="o">=</span> <span class="n">ImageCms</span><span class="o">.</span><span class="n">buildTransform</span><span class="p">(</span>
<span class="n">slide</span><span class="o">.</span><span class="n">color_profile</span><span class="p">,</span> <span class="n">toProfile</span><span class="p">,</span> <span class="s1">'RGBA'</span><span class="p">,</span> <span class="s1">'RGBA'</span><span class="p">,</span> <span class="n">intent</span><span class="p">,</span> <span class="mi">0</span>
<span class="p">)</span>
<span class="c1"># for each region image:</span>
<span class="n">ImageCms</span><span class="o">.</span><span class="n">applyTransform</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">transform</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="caching">
<h3>Caching<a class="headerlink" href="#caching" title="Link to this heading">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="openslide.OpenSlideCache">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">OpenSlideCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openslide.OpenSlideCache" title="Link to this definition">¶</a></dt>
<dd><p>An in-memory tile cache.</p>
<p>Tile caches can be attached to one or more <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a> objects
with <a class="reference internal" href="#openslide.OpenSlide.set_cache" title="openslide.OpenSlide.set_cache"><code class="xref py py-meth docutils literal notranslate"><span class="pre">OpenSlide.set_cache()</span></code></a> to cache recently-decoded tiles. By
default, each <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a> has its own cache with a default size.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>capacity</strong> – the cache capacity in bytes</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#openslide.OpenSlideVersionError" title="openslide.OpenSlideVersionError"><strong>OpenSlideVersionError</strong></a> – if OpenSlide is older than version 4.0.0</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="standard-properties">
<span id="id2"></span><h3>Standard properties<a class="headerlink" href="#standard-properties" title="Link to this heading">¶</a></h3>
<p>The <a class="reference internal" href="#module-openslide" title="openslide"><code class="xref py py-mod docutils literal notranslate"><span class="pre">openslide</span></code></a> module provides attributes containing the names of
some commonly-used OpenSlide properties.</p>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_COMMENT">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_COMMENT</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_COMMENT" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing a slide’s comment, if any.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_VENDOR">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_VENDOR</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_VENDOR" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing an identification of the vendor.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_QUICKHASH1">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_QUICKHASH1</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_QUICKHASH1" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing the “quickhash-1” sum.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_BACKGROUND_COLOR">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_BACKGROUND_COLOR</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_BACKGROUND_COLOR" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing a slide’s background color, if any.
It is represented as an RGB hex triplet.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_OBJECTIVE_POWER">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_OBJECTIVE_POWER</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_OBJECTIVE_POWER" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing a slide’s objective power, if known.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_MPP_X">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_MPP_X</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_MPP_X" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing the number of microns per pixel in
the X dimension of level 0, if known.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_MPP_Y">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_MPP_Y</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_MPP_Y" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing the number of microns per pixel in
the Y dimension of level 0, if known.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_BOUNDS_X">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_BOUNDS_X</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_BOUNDS_X" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing the X coordinate of the rectangle
bounding the non-empty region of the slide, if available.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_BOUNDS_Y">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_BOUNDS_Y</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_BOUNDS_Y" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing the Y coordinate of the rectangle
bounding the non-empty region of the slide, if available.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_BOUNDS_WIDTH">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_BOUNDS_WIDTH</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_BOUNDS_WIDTH" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing the width of the rectangle bounding
the non-empty region of the slide, if available.</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="openslide.PROPERTY_NAME_BOUNDS_HEIGHT">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">PROPERTY_NAME_BOUNDS_HEIGHT</span></span><a class="headerlink" href="#openslide.PROPERTY_NAME_BOUNDS_HEIGHT" title="Link to this definition">¶</a></dt>
<dd><p>The name of the property containing the height of the rectangle bounding
the non-empty region of the slide, if available.</p>
</dd></dl>
</section>
<section id="exceptions">
<h3>Exceptions<a class="headerlink" href="#exceptions" title="Link to this heading">¶</a></h3>
<dl class="py exception">
<dt class="sig sig-object py" id="openslide.OpenSlideError">
<span class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">OpenSlideError</span></span><a class="headerlink" href="#openslide.OpenSlideError" title="Link to this definition">¶</a></dt>
<dd><p>An error produced by the OpenSlide library.</p>
<p>Once <a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a> has been raised by a particular
<a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a>, all future operations on that <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a>
(other than <a class="reference internal" href="#openslide.OpenSlide.close" title="openslide.OpenSlide.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a>) will also raise
<a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a>.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="openslide.OpenSlideUnsupportedFormatError">
<span class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">OpenSlideUnsupportedFormatError</span></span><a class="headerlink" href="#openslide.OpenSlideUnsupportedFormatError" title="Link to this definition">¶</a></dt>
<dd><p>OpenSlide does not support the requested file. Subclass of
<a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a>.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="openslide.OpenSlideVersionError">
<span class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">OpenSlideVersionError</span></span><a class="headerlink" href="#openslide.OpenSlideVersionError" title="Link to this definition">¶</a></dt>
<dd><p>This version of OpenSlide does not support the requested functionality.
Subclass of <a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a>.</p>
</dd></dl>
</section>
</section>
<section id="wrapping-a-pillow-image">
<span id="wrapping-a-pil-image"></span><h2>Wrapping a Pillow Image<a class="headerlink" href="#wrapping-a-pillow-image" title="Link to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="openslide.AbstractSlide">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">AbstractSlide</span></span><a class="headerlink" href="#openslide.AbstractSlide" title="Link to this definition">¶</a></dt>
<dd><p>The abstract base class of <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a> and <a class="reference internal" href="#openslide.ImageSlide" title="openslide.ImageSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageSlide</span></code></a>.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="openslide.ImageSlide">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">ImageSlide</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/os.html#os.PathLike" title="(in Python v3.14)"><span class="pre">PathLike</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><span class="pre">Image</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openslide.ImageSlide" title="Link to this definition">¶</a></dt>
<dd><p>A wrapper around an <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a> object that provides an
<a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a>-compatible API.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> – a filename or <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a> object</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#OSError" title="(in Python v3.14)"><strong>OSError</strong></a> – if the file cannot be opened</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="openslide.open_slide">
<span class="sig-prename descclassname"><span class="pre">openslide.</span></span><span class="sig-name descname"><span class="pre">open_slide</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/os.html#os.PathLike" title="(in Python v3.14)"><span class="pre">PathLike</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><span class="pre">OpenSlide</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#openslide.ImageSlide" title="openslide.ImageSlide"><span class="pre">ImageSlide</span></a></span></span><a class="headerlink" href="#openslide.open_slide" title="Link to this definition">¶</a></dt>
<dd><p>Return an <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a> for whole-slide images and an
<a class="reference internal" href="#openslide.ImageSlide" title="openslide.ImageSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageSlide</span></code></a> for other types of images.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filename</strong> – the file to open</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference internal" href="#openslide.OpenSlideError" title="openslide.OpenSlideError"><strong>OpenSlideError</strong></a> – if the file is recognized by OpenSlide but an
error occurred</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#OSError" title="(in Python v3.14)"><strong>OSError</strong></a> – if the file is not recognized at all</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-openslide.deepzoom">
<span id="deep-zoom-support"></span><h2>Deep Zoom support<a class="headerlink" href="#module-openslide.deepzoom" title="Link to this heading">¶</a></h2>
<p>OpenSlide Python provides functionality for generating individual
<a class="reference external" href="https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/cc645050(v=vs.95)">Deep Zoom</a> tiles from slide objects. This is useful for displaying
whole-slide images in a web browser without converting the entire slide to
Deep Zoom or a similar format.</p>
<dl class="py class">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">openslide.deepzoom.</span></span><span class="sig-name descname"><span class="pre">DeepZoomGenerator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">osr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openslide.AbstractSlide" title="openslide.AbstractSlide"><span class="pre">AbstractSlide</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tile_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">254</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overlap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit_bounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator" title="Link to this definition">¶</a></dt>
<dd><p>A Deep Zoom generator that wraps an <a class="reference internal" href="#openslide.OpenSlide" title="openslide.OpenSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSlide</span></code></a> object,
<a class="reference internal" href="#openslide.ImageSlide" title="openslide.ImageSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageSlide</span></code></a> object, or user-provided instance of
<a class="reference internal" href="#openslide.AbstractSlide" title="openslide.AbstractSlide"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractSlide</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>osr</strong> – the slide object</p></li>
<li><p><strong>tile_size</strong> – the width and height of a single tile. For best viewer
performance, <code class="docutils literal notranslate"><span class="pre">tile_size</span> <span class="pre">+</span> <span class="pre">2</span> <span class="pre">*</span> <span class="pre">overlap</span></code> should be a power of two.</p></li>
<li><p><strong>overlap</strong> – the number of extra pixels to add to each interior edge of a
tile</p></li>
<li><p><strong>limit_bounds</strong> – <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> to render only the non-empty slide region</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.level_count">
<span class="sig-name descname"><span class="pre">level_count</span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.level_count" title="Link to this definition">¶</a></dt>
<dd><p>The number of Deep Zoom levels in the image.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.tile_count">
<span class="sig-name descname"><span class="pre">tile_count</span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.tile_count" title="Link to this definition">¶</a></dt>
<dd><p>The total number of Deep Zoom tiles in the image.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.level_tiles">
<span class="sig-name descname"><span class="pre">level_tiles</span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.level_tiles" title="Link to this definition">¶</a></dt>
<dd><p>A tuple of <code class="docutils literal notranslate"><span class="pre">(tiles_x,</span> <span class="pre">tiles_y)</span></code> tuples for each Deep Zoom level.
<code class="docutils literal notranslate"><span class="pre">level_tiles[k]</span></code> are the tile counts of level <code class="docutils literal notranslate"><span class="pre">k</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>], …]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.level_dimensions">
<span class="sig-name descname"><span class="pre">level_dimensions</span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.level_dimensions" title="Link to this definition">¶</a></dt>
<dd><p>A tuple of <code class="docutils literal notranslate"><span class="pre">(pixels_x,</span> <span class="pre">pixels_y)</span></code> tuples for each Deep Zoom level.
<code class="docutils literal notranslate"><span class="pre">level_dimensions[k]</span></code> are the dimensions of level <code class="docutils literal notranslate"><span class="pre">k</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)">int</a>], …]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.get_dzi">
<span class="sig-name descname"><span class="pre">get_dzi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.get_dzi" title="Link to this definition">¶</a></dt>
<dd><p>Return a string containing the XML metadata for the Deep Zoom <code class="docutils literal notranslate"><span class="pre">.dzi</span></code>
file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>format</strong> – the delivery format of the individual tiles (<code class="docutils literal notranslate"><span class="pre">png</span></code> or
<code class="docutils literal notranslate"><span class="pre">jpeg</span></code>)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.get_tile">
<span class="sig-name descname"><span class="pre">get_tile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><span class="pre">Image</span></a></span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.get_tile" title="Link to this definition">¶</a></dt>
<dd><p>Return an RGB <a class="reference external" href="https://pillow.readthedocs.io/en/latest/reference/Image.html#PIL.Image.Image" title="(in Pillow (PIL Fork) v12.1.0.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a> for a tile.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>level</strong> – the Deep Zoom level</p></li>
<li><p><strong>address</strong> – the address of the tile within the level as a
<code class="docutils literal notranslate"><span class="pre">(column,</span> <span class="pre">row)</span></code> tuple</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.get_tile_coordinates">
<span class="sig-name descname"><span class="pre">get_tile_coordinates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.get_tile_coordinates" title="Link to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="#openslide.OpenSlide.read_region" title="openslide.OpenSlide.read_region"><code class="xref py py-meth docutils literal notranslate"><span class="pre">OpenSlide.read_region()</span></code></a> arguments corresponding to the
specified tile.</p>
<p>Most applications should use <a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.get_tile" title="openslide.deepzoom.DeepZoomGenerator.get_tile"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_tile()</span></code></a> instead.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>level</strong> – the Deep Zoom level</p></li>
<li><p><strong>address</strong> – the address of the tile within the level as a
<code class="docutils literal notranslate"><span class="pre">(column,</span> <span class="pre">row)</span></code> tuple</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openslide.deepzoom.DeepZoomGenerator.get_tile_dimensions">
<span class="sig-name descname"><span class="pre">get_tile_dimensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#openslide.deepzoom.DeepZoomGenerator.get_tile_dimensions" title="Link to this definition">¶</a></dt>
<dd><p>Return a <code class="docutils literal notranslate"><span class="pre">(pixels_x,</span> <span class="pre">pixels_y)</span></code> tuple for the specified tile.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>level</strong> – the Deep Zoom level</p></li>
<li><p><strong>address</strong> – the address of the tile within the level as a
<code class="docutils literal notranslate"><span class="pre">(column,</span> <span class="pre">row)</span></code> tuple</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<section id="example-programs">
<h3>Example programs<a class="headerlink" href="#example-programs" title="Link to this heading">¶</a></h3>
<p>Several <a class="reference external" href="https://github.com/openslide/openslide-python/tree/main/examples/deepzoom">Deep Zoom examples</a> are included with OpenSlide Python:</p>
<dl>
<dt><a class="reference external" href="https://github.com/openslide/openslide-python/blob/main/examples/deepzoom/deepzoom_server.py">deepzoom_server.py</a></dt><dd><p>A basic server for a single slide. It serves a web page with a zoomable
slide viewer, a list of slide properties, and the ability to view
associated images.</p>
</dd>
<dt><a class="reference external" href="https://github.com/openslide/openslide-python/blob/main/examples/deepzoom/deepzoom_multiserver.py">deepzoom_multiserver.py</a></dt><dd><p>A basic server for a directory tree of slides. It serves an index page
which links to zoomable slide viewers for all slides in the tree.</p>
</dd>
<dt><a class="reference external" href="https://github.com/openslide/openslide-python/blob/main/examples/deepzoom/deepzoom_tile.py">deepzoom_tile.py</a></dt><dd><p>A program to generate and store a complete Deep Zoom directory tree for a
slide. It can optionally store an HTML page with a zoomable slide viewer,
a list of slide properties, and the ability to view associated images.</p>
<p>This program is intended as an example. If you need to generate Deep Zoom
trees for production applications, consider <a class="reference external" href="https://github.com/openslide/openslide/wiki/OpenSlideAndVIPS">using VIPS</a> instead.</p>
</dd>
</dl>
</section>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">OpenSlide Python</a><ul>
<li><a class="reference internal" href="#installing">Installing</a></li>
<li><a class="reference internal" href="#basic-usage">Basic usage</a><ul>
<li><a class="reference internal" href="#module-openslide">OpenSlide objects</a><ul>
<li><a class="reference internal" href="#openslide.OpenSlide"><code class="docutils literal notranslate"><span class="pre">OpenSlide</span></code></a><ul>
<li><a class="reference internal" href="#openslide.OpenSlide.detect_format"><code class="docutils literal notranslate"><span class="pre">OpenSlide.detect_format()</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.level_count"><code class="docutils literal notranslate"><span class="pre">OpenSlide.level_count</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.dimensions"><code class="docutils literal notranslate"><span class="pre">OpenSlide.dimensions</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.level_dimensions"><code class="docutils literal notranslate"><span class="pre">OpenSlide.level_dimensions</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.level_downsamples"><code class="docutils literal notranslate"><span class="pre">OpenSlide.level_downsamples</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.properties"><code class="docutils literal notranslate"><span class="pre">OpenSlide.properties</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.associated_images"><code class="docutils literal notranslate"><span class="pre">OpenSlide.associated_images</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.color_profile"><code class="docutils literal notranslate"><span class="pre">OpenSlide.color_profile</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.read_region"><code class="docutils literal notranslate"><span class="pre">OpenSlide.read_region()</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.get_best_level_for_downsample"><code class="docutils literal notranslate"><span class="pre">OpenSlide.get_best_level_for_downsample()</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.get_thumbnail"><code class="docutils literal notranslate"><span class="pre">OpenSlide.get_thumbnail()</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.set_cache"><code class="docutils literal notranslate"><span class="pre">OpenSlide.set_cache()</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlide.close"><code class="docutils literal notranslate"><span class="pre">OpenSlide.close()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#color-management">Color management</a></li>
<li><a class="reference internal" href="#caching">Caching</a><ul>
<li><a class="reference internal" href="#openslide.OpenSlideCache"><code class="docutils literal notranslate"><span class="pre">OpenSlideCache</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#standard-properties">Standard properties</a><ul>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_COMMENT"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_COMMENT</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_VENDOR"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_VENDOR</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_QUICKHASH1"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_QUICKHASH1</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_BACKGROUND_COLOR"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_BACKGROUND_COLOR</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_OBJECTIVE_POWER"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_OBJECTIVE_POWER</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_MPP_X"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_MPP_X</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_MPP_Y"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_MPP_Y</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_BOUNDS_X"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_BOUNDS_X</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_BOUNDS_Y"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_BOUNDS_Y</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_BOUNDS_WIDTH"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_BOUNDS_WIDTH</span></code></a></li>
<li><a class="reference internal" href="#openslide.PROPERTY_NAME_BOUNDS_HEIGHT"><code class="docutils literal notranslate"><span class="pre">PROPERTY_NAME_BOUNDS_HEIGHT</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#exceptions">Exceptions</a><ul>
<li><a class="reference internal" href="#openslide.OpenSlideError"><code class="docutils literal notranslate"><span class="pre">OpenSlideError</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlideUnsupportedFormatError"><code class="docutils literal notranslate"><span class="pre">OpenSlideUnsupportedFormatError</span></code></a></li>
<li><a class="reference internal" href="#openslide.OpenSlideVersionError"><code class="docutils literal notranslate"><span class="pre">OpenSlideVersionError</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#wrapping-a-pillow-image">Wrapping a Pillow Image</a><ul>
<li><a class="reference internal" href="#openslide.AbstractSlide"><code class="docutils literal notranslate"><span class="pre">AbstractSlide</span></code></a></li>
<li><a class="reference internal" href="#openslide.ImageSlide"><code class="docutils literal notranslate"><span class="pre">ImageSlide</span></code></a></li>
<li><a class="reference internal" href="#openslide.open_slide"><code class="docutils literal notranslate"><span class="pre">open_slide()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-openslide.deepzoom">Deep Zoom support</a><ul>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator</span></code></a><ul>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.level_count"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.level_count</span></code></a></li>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.tile_count"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.tile_count</span></code></a></li>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.level_tiles"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.level_tiles</span></code></a></li>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.level_dimensions"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.level_dimensions</span></code></a></li>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.get_dzi"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.get_dzi()</span></code></a></li>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.get_tile"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.get_tile()</span></code></a></li>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.get_tile_coordinates"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.get_tile_coordinates()</span></code></a></li>
<li><a class="reference internal" href="#openslide.deepzoom.DeepZoomGenerator.get_tile_dimensions"><code class="docutils literal notranslate"><span class="pre">DeepZoomGenerator.get_tile_dimensions()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#example-programs">Example programs</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="#">OpenSlide Python 1.4.3 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">OpenSlide Python</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010-2024 Carnegie Mellon University and others.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.0.1.
</div>
</body>
</html>