Reading of medical images


Keywords
images, pathology, tissue, medical, czi, svs, afi, scn, ndpi
License
BSD-3-Clause
Install
pip install slideio==2.7.2

Documentation

SLIDEIO - Open source python/c++ library for reading of medical images

Overview

Relevant resources:

Note: if you are interested in the python bindings of the library use SlideIO Python bindings.

Slideio is a c++ library and a python module for the reading of medical images. It allows reading whole slides as well as any region of a slide. Large slides can be effectively scaled to a smaller size. The module uses internal zoom pyramids of images to make the scaling process as fast as possible. Slideio supports 2D slides as well as 3D data sets and time series.

The module delivers a raster as a numpy array and compatible with the popular computer vision library OpenCV.

The module builds accesses images through a system of image drivers that implement specifics of different image formats. Currently following drivers are implemented:

Driver File format File extensions Format developer Scanners
SVS Aperio SVS *.svs Leica Microsystems Aperio GT 450 and Aperio GT 450 DX
AFI Aperio AFI - Fluorescent images *.afi Leica Microsystems
SCN Leica SCN images *.scn Leica Microsystems Leica SCN400
CZI Zeiss CZI images *.czi Zeiss Microscopy ZEISS Axioscan 7
ZVI Zeiss ZVI image format *.zvi Zeiss Microscopy
DCM DICOM images *.dcm, no extension
NDPI Hamamatsu NDPI image format *.ndpi Hamamatsu
VSI Olympus VSI images *.vsi
QPTIFF PerkinElmer Vectra QPTIFF *.qptiff Akoya Biosciences Perkin Elmer Vectra scanner
GDAL General image formates .jpeg,.jpg,.tiff,.tiff,*.png - -

The library is built as a c++ python extension and provides c++ and python interfaces. For details visit the library WEB site.

Build instructions

Linux build using manylinux docker containers

Prerequisites:

  • Docker
  • Python 3.6 or higher
  • git For manylinux slideio provides 2 docker containers:
  • x86_64 Linux: booritas/slideio-manylinux_2_28_x86_64:2.7.1
  • s390x Linux: booritas/slideio-manylinux_2_28_s390x:2.7.1

Build instructions

  1. Clone the repository:
git clone https://github.com/Booritas/slideio
  1. Pull docker image from the docker hub For x86_64 processor use:
docker pull booritas/slideio-manylinux_2_28_x86_64:2.7.1

For s390x processor use:

docker pull booritas/slideio-manylinux_2_28_x86_64:2.7.1
  1. Start the docker container
docker run -it -v $(PWD)/slideio:/slideio  booritas/slideio-manylinux_2_28_x86_64:2.7.1 bash
  1. Inside the container
cd /slideio
python3 install.py -a install

After the build process you can find installed files in the install subfolder of the slideio folder.

Build for Linux and Mac

Prerequisites

  • Docker
  • Python 3.6 or higher
  • conan package manager version 2 or more
  • git

Build instructions

  1. Clone the repository:
git clone https://github.com/Booritas/slideio
  1. Build custom dependencies
bash ./conan.sh
  1. Build the SlideIO library
cd /slideio
python3 install.py -a install

After the build process you can find installed files in the install subfolder of the slideio folder.

Build for Windows

Prerequisites

  • Docker
  • Python 3.6 or higher
  • conan package manager version 2 or more
  • git

Build instructions

  1. Clone the repository:
git clone https://github.com/Booritas/slideio
  1. Build custom dependencies
powershell ./conan.ps1
  1. Build the SlideIO library
cd /slideio
python3 install.py -a install

After the build process you can find installed files in the install subfolder of the slideio folder.