Registry / data / girder-large-image

girder-large-image

JSON →
library1.34.1pypypi✓ verified 81d ago

A Girder plugin for working with large, multiresolution images (e.g., whole-slide images, satellite imagery). Supports tile serving, annotation, warping, and multiple backends (OpenSlide, TIFF, DICOM). Current version 1.34.1, requires Python >=3.10, released under Apache 2.0. Package is actively maintained; releases occur approximately monthly.

dataawsgcpazure
pip install girder-large-image
github ↗package ↗
INSTALL
IMPORT
SIG · GIRDER-LARGE-IMAGE
G
girder-large-image
datapythonv1.34.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

LargeImagePlugin
✓ from girder_large_image import LargeImagePlugin
✗ from large_image.tilesource.openslide import OpenSlideFileTileSource
TilesItemResource
✓ from girder_large_image import TilesItemResource
ImageItem
✓ from girder_large_image import ImageItem

Basic usage: open a large image, read metadata, get tiles and regions.

import large_image # Open an image file (e.g., SVS, TIFF, PNG) ts = large_image.open('path/to/image.svs') # Get basic metadata print(ts.getMetadata()) # Get a tile (256x256) at level 0, coordinates (0,0) tile, format = ts.getTile(0, 0, 0) print(f'Tile size: {tile.size}, format: {format}') # Get a region (512x512) from level 1 region, format = ts.getRegion(region=dict(left=100, top=100, width=512, height=512), scale=dict(colsLevel=1)) print(f'Region size: {region.size}')
Debug
Known issues
breakingIn v1.33.0, the `frames` and `subdatasets` parameters in geospatial sources changed. Code relying on old parameter names will break.
fix
Update calls to use new parameter structure: see PR #1972.
affects: <1.33.0
deprecatedThe old `girder_large_image` import path is removed. Use `large_image` for core module, and `large_image_source_*` for specific sources.
fix
Replace `from girder_large_image import ...` with `from large_image import ...` or `from large_image.tilesource.openslide import ...`.
affects: >=1.32.0
gotchaWhen using `girder-large-image` as a Girder plugin, you must also install `girder` and configure it. The plugin is not automatically enabled.
fix
Install via `pip install girder-large-image[girder]`, then enable the plugin in Girder configuration.
affects: all
gotchaThe `pillow-jpls` module was moved out of common extras in v1.32.10. If you need JPEG-LS support, install separately.
fix
Run `pip install pillow-jpls` explicitly.
affects: >=1.32.10
Upgrade
Version history
1.34.1latest on PyPI · released Mar 24, 2026
Audit
Dependencies
girderoptionalPlugin for Girder data management platform
openslide-pythonoptionalWhole-slide image reading support
Agent activity
42 hits · last 30 days
node
36
OpenAI (training)
1
Resources
githubhttps://github.com/girder/large_image ↗
packagehttps://pypi.org/project/girder-large-image/ ↗
girder-large-image — pip install girder-large-image · libregistry