A patch miner for large histopathology images
Project description
OPM
Openslide patch manager: parallel reading/writing of patches.
Installation:
For Usage Only
conda create -p ./venv python=3.6.5 -y
conda activate ./venv
pip install OpenPatchMiner
For OPM Development
git clone https://github.com/grenkoca/OPM.git
cd OPM/
conda create -p ./venv python=3.6.5 -y
conda activate ./venv
conda install -c sdvillal openslide # this is only required for windows
pip install .
Usage
To try an example:
# continue from virtual environment shell
python patch_miner.py -i images/example_slide.tiff -lm images/example_lm.tiff -o example
By default it detects tissue and extracts 1000 random patches from the included .svs file. Play with this number as well as the number of parallel threads in example.py (default patches=1000, default threads=100)
Options
There are also a handful of useful options:
READ_TYPE
: either 'sequential' or 'random'. If sequential, it repeatedly takes the top-leftmost valid index until quota is met or the slide is saturated. If random, it randomly samples a patch from the valid indices until saturated or the quota is hit.
... and various other parameters such as patch size, thumbnail/valid mask scale, and masking thresholds.
Workflow
OPM follows the following workflow:
Project Structure
.
├── images
│ ├── example_lm.tiff
│ ├── example_slide.tiff
│ └── opm_flowchart.png
├── LICENSE.txt
├── opm
│ ├── config.py
│ ├── __init__.py
│ ├── patch_manager.py
│ ├── patch.py
│ └── utils.py
├── patch_miner.py
├── README.md
├── setup.cfg
└── setup.py
Changelog
Nov. 17, 2020:
- Added support for mining patches from label map along with the slide.
- Updated README
Jul. 31, 2020:
- Changed
ALLOW_OVERLAP
toOVERLAP_FACTOR
.OVERLAP_FACTOR
is a float from 0 to 1 that is the portion of patches that are allowed to overlap. If 0, there is no overlap allowed. If 1, they are totally allowed to overlap (except for the origin pixel).
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
OpenPatchMiner-0.1.3.tar.gz
(2.8 kB
view hashes)
Built Distribution
Close
Hashes for OpenPatchMiner-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37281afe1d39e347de2aedc97153aeea94cff18d36b7910abaf49e04989c5f4a |
|
MD5 | 6d4b08c13d26db10843cbbcf10ca491a |
|
BLAKE2b-256 | b2a254e2407d43c7addd01827f4192649c519801df6b748bf354caa09e470706 |