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.dev186-cp37-cp37m-manylinux1_x86_64.whl (928.2 kB view details)

Uploaded CPython 3.7m

histomicstk-1.0.0.dev186-cp36-cp36m-manylinux1_x86_64.whl (928.2 kB view details)

Uploaded CPython 3.6m

histomicstk-1.0.0.dev186-cp35-cp35m-manylinux1_x86_64.whl (923.3 kB view details)

Uploaded CPython 3.5m

histomicstk-1.0.0.dev186-cp27-cp27mu-manylinux1_x86_64.whl (939.3 kB view details)

Uploaded CPython 2.7mu

File details

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

File metadata

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

File hashes

Hashes for histomicstk-1.0.0.dev186-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9752bc21a8b93189bc7f5bcb05e1a5db3f1e72f7e95fc61559ad60f606f16b9a
MD5 e50d24a9fe785207959453c3cac4f017
BLAKE2b-256 fb6923225b563dcc4b02a34c6fdd272754a907fa4ccd04dc081ba0776dc163a9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for histomicstk-1.0.0.dev186-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 58120990bd415626cea35bef87060276e3e5ea63b8afd45d375567ae78eb7d23
MD5 3ddcf72cf168e87833967845c3415375
BLAKE2b-256 c84ddc47de5ece73f761d2dd66ade3db50d63a73b5ac23e1481691f717f858bb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for histomicstk-1.0.0.dev186-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 207f66ed195813a5fc0f0c1671191b939bb300aa34a8e0c32e3eb87badb5d318
MD5 c5ae3c17943cbfa3180b97c5426cd30f
BLAKE2b-256 74432fe052f193c12a05b64dd5fc532a5f270541890ade2b13ca913c79e67e8c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for histomicstk-1.0.0.dev186-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2c416ae871993907ec83234d22c5e106660c91e8a1185b77d49e037b586ea7c6
MD5 9b4867f8d873cd7aa0f775dd67f0a714
BLAKE2b-256 da716d99e61e7ac4ce698ab86daa9869b78e9b352cc85500c4d31116b2c4d466

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