large-image-source-multi

1.34.1 verified Sat May 09 auth: no python

A tile source for the large_image library that composites multiple other tile sources into a single virtual slide. Version 1.34.1 supports Python >=3.10 and adds features like two-point warp correspondence. Part of the Girder large_image ecosystem.

pip install large-image-source-multi

Common errors

error ModuleNotFoundError: No module named 'large_image_source_multi' ↓

cause Package not installed or installed under a different name

fix

Run pip install large-image-source-multi

error AttributeError: module 'large_image_source_multi' has no attribute 'MultiSourceTileSource' ↓

cause Incorrect import path

fix

Use from large_image_source_multi import MultiSourceTileSource

error ValueError: No source provided ↓

cause Empty list passed to MultiSourceTileSource

fix

Provide at least one valid tile source in the list.

Warnings

breaking Python <3.10 is no longer supported as of version 1.34.0 ↓

fix Upgrade to Python 3.10 or later.

gotcha The warp feature requires both sources to be in the same coordinate system; otherwise, compositing may misalign. ↓

fix Ensure all sources use consistent spatial reference or provide a transformation.

deprecated The `girder` extra is deprecated in favor of using `large-image-source-girder` directly ↓

fix Install `large-image-source-girder` and remove the `girder` extra.

Imports

MultiSourceTileSource

from large_image_source_multi import MultiSourceTileSource

Quickstart

Basic example of creating a multi-source tile source by compositing multiple sources.

from large_image_source_multi import MultiSourceTileSource
# Create a multi-source from two tile sources (example paths)
from large_image_source_tiff import TiledFileTileSource
source1 = TiledFileTileSource('input1.tif')
source2 = TiledFileTileSource('input2.tif')
multi = MultiSourceTileSource([source1, source2])
print(multi.getMetadata())