{"id":27914,"library":"large-image-source-tiff","title":"large-image-source-tiff","description":"A TIFF tile source plugin for the large-image library, enabling efficient reading of tiled TIFF images (including BigTIFF, GeoTIFF, and multi-resolution pyramids). Current version: 1.34.1. Released as part of the large-image ecosystem; follows the main library's release cadence (approximately monthly).","status":"active","version":"1.34.1","language":"python","source_language":"en","source_url":"https://github.com/girder/large_image","tags":["tiff","large-image","tile-source","geospatial","whole-slide-imaging"],"install":[{"cmd":"pip install large-image-source-tiff","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core library providing the tile source abstraction and caching infrastructure.","package":"large-image","optional":false},{"reason":"Used for reading TIFF files; known to cause compatibility issues with certain TIFF tags.","package":"pylibtiff","optional":true},{"reason":"Alternative TIFF reader for whole-slide images; may be used if available.","package":"openslide-python","optional":true}],"imports":[{"note":"Incorrect import path as 'large_image.tilesource' does not contain the TIFF source directly; must import from the source plugin package.","wrong":"from large_image.tilesource import TiffFileTileSource","symbol":"TiffFileTileSource","correct":"from large_image_source_tiff import TiffFileTileSource"}],"quickstart":{"code":"from large_image_source_tiff import TiffFileTileSource\n\n# Open a TIFF file\nsource = TiffFileTileSource('path/to/image.tiff')\n\n# Get basic metadata\nprint(source.getMetadata())\n\n# Get a tile (x, y, z, format, encoding)\ntile = source.getTile(0, 0, 0)\nprint('Tile data size:', len(tile))\n","lang":"python","description":"Basic usage: create a TiffFileTileSource and retrieve a tile."},"warnings":[{"fix":"Install with: pip install large-image-source-tiff[jpeg] or ensure your TIFF is tiled and uncompressed.","message":"The source only supports regular TIFF files (uncompressed, tiled). It does not handle JPEG-compressed TIFFs unless the 'pylibtiff' extra is installed and configured. Check your TIFF compression before use.","severity":"gotcha","affected_versions":"all"},{"fix":"Set before import: os.environ['LARGE_IMAGE_TIFF_READER'] = 'tifffile'","message":"Third-party readers (openslide, pylibtiff) can alter behavior. If you have multiple readers installed, the source may pick one not intended. Force a specific reader by setting environment variable LARGE_IMAGE_TIFF_READER (e.g., 'tifffile', 'pylibtiff', 'openslide').","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use the library with large-image directly; avoid relying on Girder-specific features.","message":"The 'girder' extra mark indicates future removal. The package is marked for girder < 5.0. If using Girder, prepare to migrate away from this integration.","severity":"deprecated","affected_versions":"1.34.x"},{"fix":"Upgrade to v1.34.1 or later; or use getRegion() with larger region requests.","message":"Reading a small region from a large tile can be wrong (fixed in v1.34.1). If using older versions, getTile() with sourceRegion may return incorrect data.","severity":"gotcha","affected_versions":"<1.34.1"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"pip install large-image-source-tiff","cause":"The package is not installed or is installed under a different distribution name.","error":"ModuleNotFoundError: No module named 'large_image_source_tiff'"},{"fix":"Verify file integrity, ensure TIFF is tiled, and install jpeg support: pip install large-image-source-tiff[jpeg]","cause":"File is corrupted or not a valid TIFF, or the reader does not support compression.","error":"Failed to read TIFF header: Not a TIFF or unknown format"},{"fix":"Correct import: from large_image_source_tiff import TiffFileTileSource","cause":"The class might be named differently or imported from the wrong path.","error":"ImportError: cannot import name 'TiffFileTileSource' from 'large_image_source_tiff'"},{"fix":"Use source.getMetadata() to check tile size and level dimensions; specify correct level in getTile(x, y, level).","cause":"The TIFF has non-standard tile dimensions or the source is reading at the wrong level.","error":"ValueError: tile size mismatch: expected (256, 256) but got (512, 512)"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}