A Python Toolkit and a Web-based Platform for Histopathology Image Analysis
Clone or download
cdeepakroy Merge pull request #546 from DigitalSlideArchive/easier-testing-in-do…
…cker

Improve the ability to run tests inside the docker container.
Latest commit 190f514 Sep 18, 2018
Permalink
Failed to load latest commit information.
ansible Improve the ability to run tests inside the docker container. Sep 14, 2018
docs Advertise the histomistk discourse (#544) Sep 13, 2018
histomicstk Add a togglable option for removing colinear spurs Aug 13, 2018
plugin_tests Simplify the import package test. Sep 13, 2018
sample_images Import contents of sample_images folder into TCGA collection Aug 16, 2016
server Added a function for removing thin spurs in the output of trace_objec… Aug 9, 2018
web_client Open element editor dialog from the context menu Sep 4, 2018
.dockerignore Add _skbuild to .dockerignore. Apr 25, 2017
.eslintignore Adding eslint tests Mar 23, 2016
.eslintrc Make the main page more covalic-like Feb 20, 2017
.gitignore Update cmake file to use standard tests. Jul 5, 2017
.install-openslide.sh Use the latest versions of OpenJPEG, libtiff, and Openslide in the tr… Dec 15, 2016
.travis.yml Add ACL for analysis menu. May 10, 2018
AUTHORS.rst Update documentation (#200) Sep 13, 2016
CMakeLists.txt setup: use scikit-build for building nuclear and label C extensions (#… Apr 24, 2017
CONTRIBUTING.rst Update documentation (#200) Sep 13, 2016
Dockerfile Use a branch of pylibtiff. Aug 8, 2018
Gruntfile.js Clean out gruntfile Feb 20, 2017
HISTORY.rst Changed Authors and History files Jan 13, 2016
LICENSE Reoganized the reporitory Jan 8, 2016
MANIFEST.in Made some changes to MANIFEST.in Jan 29, 2016
README.rst Advertise the histomistk discourse (#544) Sep 13, 2018
Vagrantfile Work around an Ansible 2.5 bug by pinning the version. Apr 9, 2018
__init__.py [WIP] Docker image Caching (#172) Aug 18, 2016
codecov.yml Add a codecov configuration file to ignore small variations in coverage. Jul 18, 2017
plugin.cmake Speedup nuclei detection on small ROIs (#467) Mar 1, 2018
plugin.json Add the ability to generate predefined styles Sep 26, 2017
requirements.txt Remove colinear points from annotations. Aug 9, 2018
requirements_dev.txt Jupyter notebook for reading wsi data using large_image (#526) Aug 22, 2018
setup.py setup: use scikit-build for building nuclear and label C extensions (#… Apr 24, 2017

README.rst

HistomicsTK Build Status codecov.io Code Health Join the chat at https://gitter.im/DigitalSlideArchive/HistomicsTK

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.
  • 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.