{"id":27840,"library":"girder-large-image","title":"girder-large-image","description":"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.","status":"active","version":"1.34.1","language":"python","source_language":"en","source_url":"https://github.com/girder/large_image","tags":["girder","large-image","whole-slide","tiling","openslide","geospatial"],"install":[{"cmd":"pip install girder-large-image","lang":"bash","label":"Core library (without Girder integration)"},{"cmd":"pip install girder-large-image[girder]","lang":"bash","label":"With Girder server plugin"},{"cmd":"pip install girder-large-image[openslide]","lang":"bash","label":"With OpenSlide support"}],"dependencies":[{"reason":"Plugin for Girder data management platform","package":"girder","optional":true},{"reason":"Whole-slide image reading support","package":"openslide-python","optional":true}],"imports":[{"note":"Wrong: the source module is nested under large_image.tilesource.","wrong":"from large_image_source_openslide import OpenSlideFileTileSource","symbol":"OpenSlideFileTileSource","correct":"from large_image.tilesource.openslide import OpenSlideFileTileSource"},{"note":"Wrong: the old Girder-based import path was deprecated.","wrong":"from girder_large_image import TileSource","symbol":"TileSource","correct":"from large_image import tilesource"},{"note":"Correct import for the base tile source class.","wrong":"","symbol":"tileSource","correct":"from large_image.tilesource import TileSource"}],"quickstart":{"code":"import large_image\n\n# Open an image file (e.g., SVS, TIFF, PNG)\nts = large_image.open('path/to/image.svs')\n\n# Get basic metadata\nprint(ts.getMetadata())\n\n# Get a tile (256x256) at level 0, coordinates (0,0)\ntile, format = ts.getTile(0, 0, 0)\nprint(f'Tile size: {tile.size}, format: {format}')\n\n# Get a region (512x512) from level 1\nregion, format = ts.getRegion(region=dict(left=100, top=100, width=512, height=512), scale=dict(colsLevel=1))\nprint(f'Region size: {region.size}')","lang":"python","description":"Basic usage: open a large image, read metadata, get tiles and regions."},"warnings":[{"fix":"Update calls to use new parameter structure: see PR #1972.","message":"In v1.33.0, the `frames` and `subdatasets` parameters in geospatial sources changed. Code relying on old parameter names will break.","severity":"breaking","affected_versions":"<1.33.0"},{"fix":"Replace `from girder_large_image import ...` with `from large_image import ...` or `from large_image.tilesource.openslide import ...`.","message":"The old `girder_large_image` import path is removed. Use `large_image` for core module, and `large_image_source_*` for specific sources.","severity":"deprecated","affected_versions":">=1.32.0"},{"fix":"Install via `pip install girder-large-image[girder]`, then enable the plugin in Girder configuration.","message":"When using `girder-large-image` as a Girder plugin, you must also install `girder` and configure it. The plugin is not automatically enabled.","severity":"gotcha","affected_versions":"all"},{"fix":"Run `pip install pillow-jpls` explicitly.","message":"The `pillow-jpls` module was moved out of common extras in v1.32.10. If you need JPEG-LS support, install separately.","severity":"gotcha","affected_versions":">=1.32.10"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"Run `pip install girder-large-image` (the core module). If using extras, install with e.g. `girder-large-image[openslide]`.","cause":"girder-large-image not installed or installed without core dependencies.","error":"ModuleNotFoundError: No module named 'large_image'"},{"fix":"Use `from large_image.tilesource.openslide import OpenSlideFileTileSource`.","cause":"Import path changed; the source modules are now under `large_image.tilesource`.","error":"ImportError: cannot import name 'OpenSlideFileTileSource' from 'large_image_source_openslide'"},{"fix":"Upgrade to latest version: `pip install --upgrade girder-large-image`. For versions <1.30, use `large_image.OpenSlideFileTileSource` directly.","cause":"Older versions of the library had a different API; or the library is not up to date.","error":"AttributeError: module 'large_image' has no attribute 'open'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}