Preprocessing module for large histological images.
Project description
HistoPrep
Preprocessing large medical images for machine learning made easy!
Description • Installation • Documentation • How To Use • Examples • What's coming?
Description
This module allows you to easily cut and preprocess large histological slides.
- Cut tiles from large slide images.
- Dearray TMA spots (and cut tiles from individual spots).
- Preprocess extracted tiles easily.
Installation
First install OpenCV
and OpenSlide
on your system (instructions here and here).
pip install histoprep
Detailed installation instructions can be found from HistoPrep
docs.
How To Use
HistoPrep
has a few simple commands that do most of the heavy lifting.
import histoprep as hp
# Cutting tiles is done with two lines of
cutter = hp.Cutter('/path/to/slide', width=512, overlap=0.25, max_background=0.7)
metadata = cutter.save('/path/to/output_folder')
If you have many slides to process, you can also use HistoPrep
as an excecutable for easy cutting.
python3 path/to/HistoPrep cut ./input_dir ./output_dir --width 512 --overlap 0.25 --img_type jpeg
After the tiles have been saved, preprocessing is just a simple outlier detection from the preprocessing metrics saved in metadata
!
from histoprep import preprocess
all_metadata = preprocess.collect_metadata('/path/to/output_folder')
blurry_tiles = all_metadata['sharpness_max'] < 10
pen_markings = all_metadata['hue_0.1'] < 120
weird_blue_shit = all_metadata['blue_0.05'] > 160
Examples
Detailed examples can be found in the docs or the examples folder.
What's coming?
HistoPrep
is under constant development. If there are some features you would like to be added, just submit an issue and we'll start working on the feature!
Requested features:
- Cutting and preprocessing for multichannel images (currently supports only
RGB
-images). - Add automatic detection of outliers from
metadata
.- This could be implemented with dimensionality reduction.
Citation
If you use HistoPrep
in a publication, please cite the github repository.
@misc{histoprep2021,
author = {Pohjonen J. and Ariotta. V},
title = {HistoPrep: Preprocessing large medical images for machine learning made easy!},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/jopo666/HistoPrep}},
}
Changelog
Can be found here.
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 Distribution
Built Distribution
Hashes for histoprep-0.0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 572893d542095bbcbcb0086883067e929040c1c2dcb20f7f9527a1a50deca851 |
|
MD5 | db9b35d2a3e4ecf882c936695301b26e |
|
BLAKE2b-256 | 0085e0523b47387171474b7488b67e6cecf3a24bc0d13aaaa5c6c4c4cce48b4d |