Hopiu/NDPI-to-DZI
1
0
Fork 0
mirror of https://github.com/Hopiu/NDPI-to-DZI.git synced 2026-03-16 22:00:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
NDPI-to-DZI/README.md

1.7 KiB
Raw Permalink Blame History

NDPI to DZI

Fast converter for NDPI whole-slide images to DZI (Deep Zoom Image) format, powered by libvips.

Features

  • Fast — uses libvips for multi-threaded, streaming tile generation
  • Configurable — tile size, overlap, JPEG quality, and pyramid depth as CLI options
  • Simple — single command, sensible defaults matching the DeepZoom standard

Prerequisites

  • libvips with OpenSlide support (for NDPI reading)
    • Debian/Ubuntu: sudo apt install libvips-dev
    • macOS: brew install vips
    • Arch: sudo pacman -S libvips
  • uv — Python package & project manager

Installation

git clone https://github.com/<your-username>/NDPI2DZI.git
cd NDPI2DZI
uv sync

Usage

uv run ndpi2dzi INPUT_NDPI OUTPUT_DZI

Example:

uv run ndpi2dzi slide.ndpi slide_output

This creates:

slide_output.dzi           # DZI XML metadata
slide_output_files/        # Tile directory
  0/0_0.jpeg               # Lowest-resolution level
  1/0_0.jpeg, 1_0.jpeg...
  ...
  N/...                    # Highest-resolution level

Options

Flag Default Description
--tile-size 254 Tile size in pixels
--overlap 1 Tile overlap in pixels
-q, --quality 90 JPEG quality (1–100)
--depth onetile Pyramid depth: onetile, onepixel, or one

Example with options:

uv run ndpi2dzi slide.ndpi output --tile-size 512 --overlap 2 -q 85 --depth onepixel

Run uv run ndpi2dzi --help for full usage info.

License

MIT