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
|
Metadata-Version: 1.1
Name: openslide-python
Version: 1.0.1
Summary: Python interface to OpenSlide
Home-page: http://openslide.org/
Author: OpenSlide project
Author-email: openslide-users@lists.andrew.cmu.edu
License: GNU Lesser General Public License, version 2.1
Description: ================
OpenSlide Python
================
OpenSlide Python is a Python interface to the OpenSlide library.
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.
OpenSlide can read virtual slides in several formats:
* Aperio_ (``.svs``, ``.tif``)
* Hamamatsu_ (``.ndpi``, ``.vms``, ``.vmu``)
* Leica_ (``.scn``)
* MIRAX_ (``.mrxs``)
* Sakura_ (``.svslide``)
* Trestle_ (``.tif``)
* Ventana_ (``.bif``)
* `Generic tiled TIFF`_ (``.tif``)
.. _OpenSlide: http://openslide.org/
.. _Aperio: http://openslide.org/formats/aperio/
.. _Hamamatsu: http://openslide.org/formats/hamamatsu/
.. _Leica: http://openslide.org/formats/leica/
.. _MIRAX: http://openslide.org/formats/mirax/
.. _Sakura: http://openslide.org/formats/sakura/
.. _Trestle: http://openslide.org/formats/trestle/
.. _Ventana: http://openslide.org/formats/ventana/
.. _`Generic tiled TIFF`: http://openslide.org/formats/generic-tiff/
Requirements
============
* Python 2 >= 2.6 or Python 3 >= 3.3
* OpenSlide >= 3.4.0
* Python Imaging Library or Pillow
Installation
============
1. `Install OpenSlide`_.
2. ``pip install openslide-python``
.. _`Install OpenSlide`: http://openslide.org/download/
Using PIL
---------
``setup.py`` assumes that you want to use the Pillow fork of PIL. If you
already have classic PIL installed, you can use it instead. Install
OpenSlide Python with:
::
pip install --no-deps openslide-python
or, if you are installing by hand:
::
python setup.py install --single-version-externally-managed --record /dev/null
More Information
================
- `API documentation`_
- Changelog_
- Website_
- GitHub_
- `Sample data`_
.. _`API documentation`: http://openslide.org/api/python/
.. _Changelog: https://raw.github.com/openslide/openslide-python/master/CHANGELOG.txt
.. _Website: http://openslide.org/
.. _GitHub: https://github.com/openslide/openslide-python
.. _`Sample data`: http://openslide.cs.cmu.edu/download/openslide-testdata/
License
=======
OpenSlide Python is released under the terms of the `GNU Lesser General
Public License, version 2.1`_.
.. _`GNU Lesser General Public License, version 2.1`: https://raw.github.com/openslide/openslide-python/master/lgpl-2.1.txt
Keywords: openslide whole-slide image virtual slide library
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
|
