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

Uploaded CPython 3.7m

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

Uploaded CPython 3.6m

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

Uploaded CPython 3.5m

histomicstk-1.0.0.dev133-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.dev133-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.0.dev133-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.dev133-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f7f1c5dc9d1e4dbea0c79d698d912fed7aade7d6c849e045605a85f233531014
MD5 4868c4b437638516c170b606181122de
BLAKE2b-256 678ece9b81ce2e0870a2909b151666317e81ff565e5d9e9df9f87f3c7bb50d0a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: histomicstk-1.0.0.dev133-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.dev133-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9637d0730fcc10c47f872a996f0f752d20b2b6f4897e526af7940604ee433645
MD5 3f34a63efe8ef609356cac85f741e9c0
BLAKE2b-256 5b4c6d5751a9a027f52328e20e0e47d9b3e32d85c69c9be0bafb28efe1cff280

See more details on using hashes here.

File details

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

File metadata

  • Download URL: histomicstk-1.0.0.dev133-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.dev133-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 8c2ee62004373a853271b583ee1c000aa92d8fbeaa69fd0cf2b40a8cd4f26a04
MD5 aadb31a482d4a1b7bde82897d8a6f93f
BLAKE2b-256 082bb908bc37b895108df81cb48b544d2c81c91c7721c0d4f9a281452fc46a06

See more details on using hashes here.

File details

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

File metadata

  • Download URL: histomicstk-1.0.0.dev133-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.dev133-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c830cbb9a9dd82acd162bb3df60940e61a420531917a9c2dbe41e1f3a418d1e4
MD5 87aad8f3153cf4d2f54bef91de0a6a79
BLAKE2b-256 2caf2f5a39b11beb50bab13933d13fa7e3c01b398fbb343410a6455b239305c9

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