A Python toolkit for Histopathology Image Analysis
Project description
HistomicsTK is a Python and REST API for the analysis of Histopathology images in association with clinical and genomic data.
Histopathology, which involves the examination of thin-slices of diseased tissue at a cellular resolution using a microscope, is regarded as the gold standard in clinical diagnosis, staging, and prognosis of several diseases including most types of cancer. The recent emergence and increased clinical adoption of whole-slide imaging systems that capture large digital images of an entire tissue section at a high magnification, has resulted in an explosion of data. Compared to the related areas of radiology and genomics, there is a dearth of mature open-source tools for the management, visualization and quantitative analysis of the massive and rapidly growing collections of data in the domain of digital pathology. This is precisely the gap that we aim to fill with the development of HistomicsTK.
Developed in coordination with the Digital Slide Archive and large_image, HistomicsTK aims to serve the needs of both pathologists/biologists interested in using state-of-the-art algorithms to analyze their data, and algorithm researchers interested in developing new/improved algorithms and disseminate them for wider use by the community.
You may view the following introductory videos for more information about DSA and HistomicsTK:
General overview: https://www.youtube.com/watch?v=NenUKZaT–k
Simple annotation and data management tutorial: https://www.youtube.com/watch?v=HTvLMyKYyGs
HistomicsTK can be used in two ways:
As a pure Python package: This is intended to enable algorithm researchers to use and/or extend the analytics functionality within HistomicsTK in Python. HistomicsTK provides algorithms for fundamental image analysis tasks such as color normalization, color deconvolution, cell-nuclei segmentation, and feature extraction. Please see the api-docs and examples for more information.
Installation instructions on Linux:
To install HistomicsTK using PyPI:
$ python -m pip install histomicstk
To install HistomicsTK from source:
$ git clone https://github.com/DigitalSlideArchive/HistomicsTK/ $ cd HistomicsTK/ $ python -m pip install setuptools-scm Cython>=1.25.2 scikit-build>=0.8.1 cmake>=0.6.0 numpy>=1.12.1 $ python -m pip install -e .
HistomicsTK uses the large_image library to read and various microscopy image formats. Depending on your exact system, installing the necessary libraries to support these formats can be complex. There are some non-official prebuilt libraries available for Linux that can be included as part of the installation by specifying pip install histomicstk --find-links https://girder.github.io/large_image_wheels. Note that if you previously installed HistomicsTK or large_image without these, you may need to add --force-reinstall --no-cache-dir to the pip install command to force it to use the find-links option.
The system version of various libraries are used if the --find-links option is not specified. You will need to use your package manager to install appropriate libraries (on Ubuntu, for instance, you’ll need libopenslide-dev and libtiff-dev).
As a server-side Girder plugin for web-based analysis: This is intended to allow pathologists/biologists to apply analysis modules/pipelines containerized in HistomicsTK’s docker plugins on data over the web. Girder is a Python-based framework (under active development by Kitware) for building web-applications that store, aggregate, and process scientific data. It is built on CherryPy and provides functionality for authentication, access control, customizable metadata association, easy upload/download of data, an abstraction layer that exposes data stored on multiple backends (e.g. Native file system, Amazon S3, MongoDB GridFS) through a uniform RESTful API, and most importantly an extensible plugin framework for building server-side analytics apps. To inherit all these capabilities, HistomicsTK is being developed to act also as a Girder plugin in addition to its use as a pure Python package. To further support web-based analysis, HistomicsTK depends on three other Girder plugins: (i) girder_worker for distributed task execution and monitoring, (ii) large_image for displaying, serving, and reading large multi-resolution images produced by whole-slide imaging systems, and (iii) slicer_cli_web to provide web-based RESTFul access to image analysis pipelines developed as slicer execution model CLIs and containerized using Docker.
Please refer to https://digitalslidearchive.github.io/HistomicsTK/ for more information.
For questions, comments, or to get in touch with the maintainers, head to our Discourse forum, or use our Gitter Chatroom.
This work is funded by the NIH grant U24-CA194362-01.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
File details
Details for the file histomicstk-1.0.3.dev28-cp37-cp37m-manylinux2010_x86_64.whl.
File metadata
- Download URL: histomicstk-1.0.3.dev28-cp37-cp37m-manylinux2010_x86_64.whl
- Upload date:
- Size: 966.1 kB
- Tags: CPython 3.7m, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11aeb1e2eeda2ae38a310032a8c10a86238283cb30ceaadde4ae8d6fb573804a |
|
| MD5 | 210c1a6f3de321b7c52574fc7532366a |
|
| BLAKE2b-256 | ddd2558eb3b50cfddaefb5350e6d5228af444bd8d333114fb64219aefdde2154 |
Provenance
File details
Details for the file histomicstk-1.0.3.dev28-cp36-cp36m-manylinux2010_x86_64.whl.
File metadata
- Download URL: histomicstk-1.0.3.dev28-cp36-cp36m-manylinux2010_x86_64.whl
- Upload date:
- Size: 966.8 kB
- Tags: CPython 3.6m, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 734a2939a1e25c88a9ec7eba099daf27e84889008eaec2a53964c5def23b4633 |
|
| MD5 | f4c9e4aaf1bf6b32a8a6c05b3002a037 |
|
| BLAKE2b-256 | 53f9e4a05715685b6caede7ad558d1ce23656b1f794c34e4d24ff9ba583ef2a5 |
Provenance
File details
Details for the file histomicstk-1.0.3.dev28-cp35-cp35m-manylinux2010_x86_64.whl.
File metadata
- Download URL: histomicstk-1.0.3.dev28-cp35-cp35m-manylinux2010_x86_64.whl
- Upload date:
- Size: 962.2 kB
- Tags: CPython 3.5m, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 202f7b3db6eb4ae852e62a6e8d8e7ef5a5f56e6d6990fcd658c48dfdc5b6a50f |
|
| MD5 | 1b45dc985d697b46e584cfc0b28a9bf0 |
|
| BLAKE2b-256 | 25afaadaf822d2c56d3393047610bdf6530aa46f1196ba16d0c617d8ef1a7048 |
Provenance
File details
Details for the file histomicstk-1.0.3.dev28-cp27-cp27mu-manylinux2010_x86_64.whl.
File metadata
- Download URL: histomicstk-1.0.3.dev28-cp27-cp27mu-manylinux2010_x86_64.whl
- Upload date:
- Size: 977.8 kB
- Tags: CPython 2.7mu, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 77a132908d056c130f99146b8d07815befdd0664987fc8735a1556fdee536328 |
|
| MD5 | 71941ee143f914503f709087211d0766 |
|
| BLAKE2b-256 | e169aeeee69ab45850a90fb5fe1ed233ed2fe8e52da1d3535d0456f987515d5e |
