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.

You may view the following introductory videos for more information about DSA and HistomicsTK:

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.

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

histomicstk-1.0.3.dev56-cp37-cp37m-manylinux2010_x86_64.whl (968.6 kB view details)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

histomicstk-1.0.3.dev56-cp36-cp36m-manylinux2010_x86_64.whl (969.3 kB view details)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

histomicstk-1.0.3.dev56-cp35-cp35m-manylinux2010_x86_64.whl (964.7 kB view details)

Uploaded CPython 3.5m manylinux: glibc 2.12+ x86-64

histomicstk-1.0.3.dev56-cp27-cp27mu-manylinux2010_x86_64.whl (980.2 kB view details)

Uploaded CPython 2.7mu manylinux: glibc 2.12+ x86-64

File details

Details for the file histomicstk-1.0.3.dev56-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.3.dev56-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 968.6 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.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10

File hashes

Hashes for histomicstk-1.0.3.dev56-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 e37ac68352034add0f87f4845bac7e1d952f13fe408041a0a2ccae81f0f534ce
MD5 5be79873c2d211f1504091bde3cfb6d7
BLAKE2b-256 3bee5ef973acad0b1e35ed1a1753f9300c15d2143dcb254b37046a903a39ad9f

See more details on using hashes here.

Provenance

File details

Details for the file histomicstk-1.0.3.dev56-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.3.dev56-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 969.3 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.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10

File hashes

Hashes for histomicstk-1.0.3.dev56-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 6bb47f9d02ead62f64d77d5fd0ea1855b51369eca4a7b72b8277163df23150b6
MD5 dc7f9770a1677c510e78432f94fc2511
BLAKE2b-256 13bb4006bb2e0f125a3547a9638c25fbc08acf027f31c15d2055239d8416c396

See more details on using hashes here.

Provenance

File details

Details for the file histomicstk-1.0.3.dev56-cp35-cp35m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.3.dev56-cp35-cp35m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 964.7 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.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10

File hashes

Hashes for histomicstk-1.0.3.dev56-cp35-cp35m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 cb3a4cfa24d05e6a00b9f5f9cb178a30abd71d71bcfd8d9539b6ca7e21061476
MD5 8160d6b0c56c765399962cd2aba0cf81
BLAKE2b-256 f5c5bf6f432aaacd982179d3efb83b1c1725364bafcf67b01b2956ffb9877665

See more details on using hashes here.

Provenance

File details

Details for the file histomicstk-1.0.3.dev56-cp27-cp27mu-manylinux2010_x86_64.whl.

File metadata

  • Download URL: histomicstk-1.0.3.dev56-cp27-cp27mu-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 980.2 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.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.10

File hashes

Hashes for histomicstk-1.0.3.dev56-cp27-cp27mu-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 6e397b600dabefaf94fb0ee7dd0014497f63a6ce9cc81b3b86ecaf405d800da3
MD5 0ce86483be10ea5161dd3b292a450d5c
BLAKE2b-256 095bded9b4bdbefe0d6e4bd2ad785b35c3fe53343366e644070619ed5948b832

See more details on using hashes here.

Provenance

Supported by

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