Skip to main content

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.

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.

    This can be installed on Linux via pip install histomicstk.

    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://manthey.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.

Project details


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

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

histomicstk-1.0.0.dev131-cp37-cp37m-manylinux1_x86_64.whl (695.1 kB view details)

Uploaded CPython 3.7m

histomicstk-1.0.0.dev131-cp36-cp36m-manylinux1_x86_64.whl (695.1 kB view details)

Uploaded CPython 3.6m

histomicstk-1.0.0.dev131-cp35-cp35m-manylinux1_x86_64.whl (690.2 kB view details)

Uploaded CPython 3.5m

histomicstk-1.0.0.dev131-cp27-cp27mu-manylinux1_x86_64.whl (706.2 kB view details)

Uploaded CPython 2.7mu

File details

Details for the file histomicstk-1.0.0.dev131-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.0.dev131-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 695.1 kB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.9

File hashes

Hashes for histomicstk-1.0.0.dev131-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0bac7a8220dec96b99a9cd46c0aa3551a9db3020f0934a9e8de67767f5ce5fd8
MD5 2f96346f294e42acef822bbad574a8e7
BLAKE2b-256 4338e4847e3bfbbe1a751139cd52a50cdf673352835c763f851f76ec5a07fc7b

See more details on using hashes here.

File details

Details for the file histomicstk-1.0.0.dev131-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.0.dev131-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 695.1 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.9

File hashes

Hashes for histomicstk-1.0.0.dev131-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f1a752edeef2918a00a4ab5bcb0993ac6ad85d57595d59577ebe985833593783
MD5 6b1e540d37ee75c34245be523c375e80
BLAKE2b-256 7e9206876fc46e5eee43ae7a8494036c4de096098804d98e7640179ece659cd2

See more details on using hashes here.

File details

Details for the file histomicstk-1.0.0.dev131-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.0.dev131-cp35-cp35m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 690.2 kB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.9

File hashes

Hashes for histomicstk-1.0.0.dev131-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 6ea46b529dbd232aa5d5571080d3e917347795f10f19fe92bde205403e37a8ac
MD5 af52c6386af06375aeb8c8c4a6a8b240
BLAKE2b-256 44beadf3edb38b61b9a13499cbfd939b91525e7fbeb7787d8956610f27f5d150

See more details on using hashes here.

File details

Details for the file histomicstk-1.0.0.dev131-cp27-cp27mu-manylinux1_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.0.dev131-cp27-cp27mu-manylinux1_x86_64.whl
  • Upload date:
  • Size: 706.2 kB
  • Tags: CPython 2.7mu
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.9

File hashes

Hashes for histomicstk-1.0.0.dev131-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 af97fcc1b98a48aa93c966f44528433d88aa7a35bfcdfb06e5f4563a06349852
MD5 cd75c882534529acb97276f8b641bc7f
BLAKE2b-256 98b07e9b124b9ef8a47868c5a32fa1ccb1e1ee10f4d6022775d6e33be067b632

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page