large-image-source-ometiff

1.34.1 verified Sat May 09 auth: no python

An OMETiff tilesource for large_image, a Python framework for reading and serving large multiresolution images. Version 1.34.1 supports Python >=3.10, releases monthly via the girder/large_image monorepo.

pip install large-image-source-ometiff

Common errors

error ModuleNotFoundError: No module named 'large_image_source_ometiff' ↓

cause Installed the wrong package or forgot to install the source plugin.

fix

Run pip install large-image-source-ometiff and ensure you're using the correct Python environment.

error AttributeError: module 'large_image' has no attribute 'OMETiffGirderTileSource' ↓

cause Attempting to import the class from the top-level `large_image` package.

fix

Use from large_image_source_ometiff import OMETiffGirderTileSource.

error large_image.common.TileSourceException: No available tile source for 'file.ome.tif' ↓

cause The file is not recognized as a valid OME-TIFF or the source plugin is not installed.

fix

Verify the file is a valid OME-TIFF and install large-image-source-ometiff: pip install large-image-source-ometiff.

Warnings

gotcha The package name uses underscores in imports (large_image_source_ometiff), not hyphens. ↓

fix Use `import large_image_source_ometiff` or `from large_image_source_ometiff import ...`

deprecated Girder integration is deprecated. Girder versions <5 are supported, but future releases may drop support. ↓

fix Use the standalone large-image framework without Girder, or migrate to Girder 5+ if needed.

breaking Python 3.10 is the minimum required version starting from v1.34.0. ↓

fix Upgrade to Python 3.10 or later.

Imports

OMETiffGirderTileSource
wrong
```
from large_image import OMETiffGirderTileSource
```
correct
```
from large_image_source_ometiff import OMETiffGirderTileSource
```
Source classes are exported from their own package, not the top-level large_image module.

Quickstart

Basic usage: open an OME-TIFF file and get a tile.

from large_image_source_ometiff import OMETiffGirderTileSource
from large_image import getTileSource

# Open an OME-TIFF file
ts = getTileSource('path/to/image.ome.tif')
tile = ts.getTile(0, 0, format='PNG')  # fetch tile at level 0, position (0,0)
print(tile[:10])  # raw bytes preview