titiler-mosaic

2.0.1 verified Mon Apr 27 auth: no python

TiTiler plugin for MosaicJSON (cogeo-mosaic) support. Version 2.0.1, active development. Allows creating tile endpoints from mosaic JSON documents.

pip install titiler-mosaic

Common errors

error ImportError: cannot import name 'MosaicTilerFactory' from 'titiler.mosaic' ↓

cause MosaicTilerFactory is in the factory submodule, not directly in titiler.mosaic.

fix

Use: from titiler.mosaic.factory import MosaicTilerFactory

error TypeError: MosaicTilerFactory.__init__() missing 1 required positional argument: 'reader' ↓

cause In titiler-mosaic 2.0, reader argument is required.

fix

Provide a reader class: MosaicTilerFactory(reader=MyReader)

Warnings

breaking In titiler 2.0, the MosaicTilerFactory constructor signature changed. The `reader` parameter is now required and must be a reader class that inherits from BaseReader. ↓

fix Pass a valid reader class (e.g., from cogeo_mosaic.mosaic import MosaicJSON) to MosaicTilerFactory(reader=...).

deprecated The `pixel-selection` method is deprecated in favor of `pixel_selection` (underscore). Old parameter names will be removed in a future version. ↓

fix Use `pixel_selection` instead of `pixel-selection` in endpoint parameters.

gotcha The `assets` parameter is now required for tile endpoints. Use `assets=:all:` to include all assets from the mosaic. ↓

fix Always include assets parameter in tile requests, e.g., `assets=:all:` or a comma-separated list.

Imports

MosaicTilerFactory
wrong
```
from titiler.mosaic import MosaicTilerFactory
```
correct
```
from titiler.mosaic.factory import MosaicTilerFactory
```
MosaicTilerFactory is in the factory submodule, not directly in titiler.mosaic

Quickstart

Minimal setup to add mosaic tile endpoints to a FastAPI app.

from fastapi import FastAPI
from titiler.mosaic.factory import MosaicTilerFactory

app = FastAPI()
mosaic = MosaicTilerFactory()
app.include_router(mosaic.router)