Overview
The tutorials are Jupyter notebooks, each working through one part of the library with runnable code and sample images. They use the Python module, but most of what they cover — zoom pyramids, scenes, metadata, colour profiles — applies equally to the C++ API.
They live in their own repository, Booritas/slideio-tutorial. GitHub renders notebooks in the browser, so you can read any of them without installing anything.
Running them
git clone https://github.com/Booritas/slideio-tutorial.git
cd slideio-tutorial
pip install -r requirements.txt
jupyter notebook
The notebooks download the slides they use, so no test corpus is needed.
The notebooks
Getting started
- general.ipynb — an introduction to the library: opening a slide, reading regions, extracting metadata, and the other everyday tasks.
- zoom-levels.ipynb
— reading from an explicitly chosen pyramid level: inspecting a scene’s
levels, reading a region in a level’s own coordinates with
read_block_from_level, walking a level tile by tile the way a viewer would, and the assumptions about level geometry that real files break.
Formats
- dicom.ipynb — reading DICOM files.
- dicom-xd.ipynb — multidimensional DICOM images.
- dicom-wsi.ipynb — DICOM whole-slide images.
- olympus.ipynb — Olympus VSI files.
- ometiff.ipynb — OME-TIFF images.
Transforming and converting
- converter.ipynb — converting slides to the Aperio SVS format, step by step.
- color-management.ipynb
— the colour profile API: reading the ICC profile a scene embeds, recording
where a colour claim came from, and converting pixels through the profile
with the
ColorManagementtransformation, including slides that carry no profile at all. - color-transformations.ipynb — colour transformations: manipulating channels, adjusting brightness and contrast, and related operations.
- filter-transformation.ipynb — applying filters such as blurring, sharpening and edge detection.
Reference documentation
For the API itself rather than worked examples, see the Python API and C++ API pages, and the Sphinx reference.