Skip to main content

tests workflow codecov Documentation Status Codacy Badge


dogsled is an open-source Python package that does only one thing: Macenko [1] stain normalisation of large medical slides (OpenSlide formats). It generates either JPEG or TIFF normalised image.

It is crucial to have a dataset of high quality when, for example, training deep learning models. When working with medical slides, the colour might differ from slide to slide, making it harder to work with them as it causes heterogenicity in the data set. Stain normalisation is one of the techniques used to mitigate this hurdle and homogenise the slide colour. However, the size of the medical slides, which can go beyond gigapixel, makes it challenging to perform such a task. No worries, dogsled is there to help you.

Why dogsled? Well, first of all, because of the dogs. Second, because together many dogs can push a cargo too heavy for one dog to handle. Similarily, dogsled divides heavy computations into smaller ones. As with many algorithms and life situations, divide and conquer, right?

dogsled is in late alpha phase

if you spot a bug or have a suggestion feel free to open an issue

if wish to test dogsled and need the data, feel free to drop me an email at: dmitri.stepanov1@gmail.com

Quirks and features

Currently, dogsled can:

  • normalise all slides located in a specified folder
  • normalise slides specified by name
  • normalise slides defined in a QuPath library (either all or the ones specified by name and/or index)
  • generate JPEG equivalents of the normalised slides
  • generate TIFF equivalents of the normalised slides (also for large slides not fitting in RAM)
  • create hematoxylin/eosin decoupled normalised images
  • create thumbnails of all slides (pre-normalised and normalised)

Documentation

dogsled about page, quickstart, installation and API can be found at dogsled.readthedocs.io



[1] M. Macenko, M. Niethammer, J. S. Marron, D. Borland, J. T. Woosley, Guan Xiaojun, C. Schmitt, and N. E. Thomas. A method for normalizing histology slides for quantitative analysis. In 2009 IEEE International Symposium on Biomedical Imaging: From Nano to Macro, 1107–1110. 2009. doi:10.1109/ISBI.2009.5193250.

Metadata

Release files for dogsled 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dogsled 0.0.5
File Size Uploaded
dogsled-0.0.5.tar.gz 45.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for dogsled 0.0.5
File Interpreter ABI Platform
dogsled-0.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 45.3 MB

Release files / dogsled-0.0.5.tar.gz

Download URL dogsled-0.0.5.tar.gz
Size 45.3 MB
Tags Source
SHA-256 checksum
How to use checksums
144ef9124d5671905d96a3663ea74d5c169aee631f8c29dba6b25c33cdc000b8
BLAKE2b-256 checksum
How to use checksums
7264cb7e2bd9fe03e62d17e17741612bf0b891f65c9ff49f586e0da7147e166d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release files / dogsled-0.0.5-py3-none-any.whl

Download URL dogsled-0.0.5-py3-none-any.whl
Size 35.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c4612f8e65d2e679d358c9d35ac33493b8f8c89a9f96b620de7f3c1fa7438c7
BLAKE2b-256 checksum
How to use checksums
efa1396d98d42c42231a76be49c08e2a6e027b65be4da145b9cf620f94f00d11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release history Release notifications | RSS feed

This release

0.0.5 This release

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

3 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page