Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
coordinates: list[float]
assets: list[AssetPoint]
```
* add `/feature`, `/bbox` and `/statistics` optional endpoints
* make `cogeo-mosaic` an optional dependency **breaking change**
* remove default for `MosaicTilerFactory.backend` attribute **breaking change**

## 0.26.0 (2025-11-25)

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ dependencies = [
"titiler-core",
"titiler-xarray",
"titiler-extensions",
"titiler-mosaic",
"titiler-mosaic[mosaicjson]",
"titiler-application",
]

Expand Down
2 changes: 1 addition & 1 deletion src/titiler/application/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ dynamic = ["version"]
dependencies = [
"titiler-core[telemetry]==0.26.0",
"titiler-extensions[cogeo,stac]==0.26.0",
"titiler-mosaic==0.26.0",
"titiler-mosaic[mosaicjson]==0.26.0",
"starlette-cramjam>=0.4,<0.6",
"pydantic-settings~=2.0",
]
Expand Down
13 changes: 13 additions & 0 deletions src/titiler/application/titiler/application/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@

import jinja2
import rasterio
from cogeo_mosaic.backends import MosaicBackend as MosaicJSONBackend
from cogeo_mosaic.errors import MosaicAuthError, MosaicError, MosaicNotFoundError
from fastapi import Depends, FastAPI, HTTPException, Query, Security
from fastapi.security.api_key import APIKeyQuery
from rio_tiler.io import Reader, STACReader
from starlette import status
from starlette.middleware.cors import CORSMiddleware
from starlette.requests import Request
from starlette.templating import Jinja2Templates
Expand Down Expand Up @@ -170,6 +173,7 @@ def validate_access_token(access_token: str = Security(api_key_query)):
# Mosaic endpoints
if not api_settings.disable_mosaic:
mosaic = MosaicTilerFactory(
backend=MosaicJSONBackend,
router_prefix="/mosaicjson",
extensions=[
MosaicJSONExtension(),
Expand Down Expand Up @@ -214,6 +218,15 @@ def validate_access_token(access_token: str = Security(api_key_query)):


add_exception_handlers(app, DEFAULT_STATUS_CODES)

# Add Mosaic specific error handlers
MOSAIC_STATUS_CODES.update(
{
MosaicAuthError: status.HTTP_401_UNAUTHORIZED,
MosaicError: status.HTTP_424_FAILED_DEPENDENCY,
MosaicNotFoundError: status.HTTP_404_NOT_FOUND,
}
)
add_exception_handlers(app, MOSAIC_STATUS_CODES)

# Set all CORS enabled origins
Expand Down
9 changes: 8 additions & 1 deletion src/titiler/core/titiler/core/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -701,7 +701,14 @@ async def tileset_list(
response_model=TileSet,
response_class=JSONResponse,
response_model_exclude_none=True,
responses={200: {"content": {"application/json": {}}}},
responses={
200: {
"content": {
"application/json": {},
"text/html": {},
}
}
},
summary="Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).",
operation_id=f"{self.operation_prefix}getTileSet",
)
Expand Down
4 changes: 4 additions & 0 deletions src/titiler/mosaic/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ classifiers = [
dynamic = ["version"]
dependencies = [
"titiler-core==0.26.0",
]

[project.optional-dependencies]
mosaicjson = [
"cogeo-mosaic>=9.0,<10.0",
]

Expand Down
182 changes: 171 additions & 11 deletions src/titiler/mosaic/tests/test_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@
from contextlib import contextmanager
from dataclasses import dataclass
from io import BytesIO
from typing import Annotated, List, Optional
from typing import Annotated, Any, List, Optional
from unittest.mock import patch

import attr
import morecantile
import numpy
from cogeo_mosaic.backends import FileBackend
from cogeo_mosaic.backends import MosaicBackend as MosaicJSONBackend
from cogeo_mosaic.mosaic import MosaicJSON
from fastapi import FastAPI, Query
from rio_tiler.mosaic.methods import PixelSelectionMethod
Expand All @@ -22,7 +23,7 @@
from titiler.mosaic.extensions import MosaicJSONExtension
from titiler.mosaic.factory import MosaicTilerFactory

from .conftest import DATA_DIR
from .conftest import DATA_DIR, parse_img

assets = [os.path.join(DATA_DIR, asset) for asset in ["cog1.tif", "cog2.tif"]]
DEFAULT_TMS = morecantile.tms
Expand All @@ -47,22 +48,36 @@ def tmpmosaic():
def test_MosaicTilerFactory():
"""Test MosaicTilerFactory class."""
mosaic = MosaicTilerFactory(
backend=MosaicJSONBackend,
optional_headers=[OptionalHeader.x_assets],
router_prefix="mosaic",
)
assert len(mosaic.router.routes) == 15

@dataclass
class MosaicJSONAccessor(DefaultDependency):
"""MosaicJSON Accessor Options."""

reverse: Annotated[
bool,
Query(),
] = False

mosaic = MosaicTilerFactory(
backend=MosaicJSONBackend,
assets_accessor_dependency=MosaicJSONAccessor,
optional_headers=[
OptionalHeader.x_assets,
OptionalHeader.server_timing,
],
extensions=[
MosaicJSONExtension(),
],
add_statistics=True,
add_part=True,
router_prefix="mosaic",
)
assert len(mosaic.router.routes) == 17
assert len(mosaic.router.routes) == 23

app = FastAPI()
app.include_router(mosaic.router, prefix="/mosaic")
Expand Down Expand Up @@ -111,7 +126,6 @@ def test_MosaicTilerFactory():
assert response.status_code == 200
assert response.json()["coordinates"]
v = response.json()["assets"]

# one asset found
assert len(v) == 1
assert v[0]["name"]
Expand All @@ -120,6 +134,30 @@ def test_MosaicTilerFactory():
assert v[0]["band_names"] == ["b1", "b2", "b3"]
assert v[0]["band_descriptions"]

response = client.get(
"/mosaic/point/-73,45",
params={"url": mosaic_file},
)
assert response.status_code == 200
assert response.json()["coordinates"]
v = response.json()["assets"]
# two asset found
assert len(v) == 2
names = [asset["name"] for asset in v]
assert names == assets

response = client.get(
"/mosaic/point/-73,45",
params={"url": mosaic_file, "reverse": True},
)
assert response.status_code == 200
assert response.json()["coordinates"]
v = response.json()["assets"]
# two asset found
assert len(v) == 2
names = [asset["name"] for asset in v]
assert names == list(reversed(assets))

# Masked values
response = client.get(
"/mosaic/point/-75.759,46.3847",
Expand All @@ -128,7 +166,6 @@ def test_MosaicTilerFactory():
assert response.status_code == 200
assert response.json()["coordinates"]
v = response.json()["assets"]

# one asset found
assert len(v) == 1
assert v[0]["name"]
Expand Down Expand Up @@ -248,10 +285,13 @@ def test_MosaicTilerFactory():
"/mosaic/point/-71,46/assets", params={"url": mosaic_file}
)
assert response.status_code == 200
assert all(
filepath.split("/")[-1] in ["cog1.tif", "cog2.tif"]
for filepath in response.json()
assert response.json() == assets

response = client.get(
"/mosaic/point/-71,46/assets", params={"url": mosaic_file, "reverse": True}
)
assert response.status_code == 200
assert response.json() == list(reversed(assets))

response = client.get(
"/mosaic/point/-7903683.846322423,5780349.220256353/assets",
Expand Down Expand Up @@ -302,13 +342,127 @@ def test_MosaicTilerFactory():
assert first_id in first_tms["title"]
assert len(first_tms["links"]) == 2 # no link to the tms definition

response = client.get(
f"/mosaic/tiles?url={mosaic_file}", headers={"Accept": "text/html"}
)
assert response.status_code == 200
assert "text/html" in response.headers["content-type"]

response = client.get("/mosaic/tiles", params={"url": mosaic_file, "f": "html"})
assert response.status_code == 200
assert "text/html" in response.headers["content-type"]

response = client.get(f"/mosaic/tiles/WebMercatorQuad?url={mosaic_file}")
assert response.status_code == 200
assert response.headers["content-type"] == "application/json"
resp = response.json()
# covers only 3 zoom levels
assert len(resp["tileMatrixSetLimits"]) == 3

response = client.get(
f"/mosaic/tiles/WebMercatorQuad?url={mosaic_file}",
headers={"Accept": "text/html"},
)
assert response.status_code == 200
assert "text/html" in response.headers["content-type"]

response = client.get(
"/mosaic/tiles/WebMercatorQuad", params={"url": mosaic_file, "f": "html"}
)
assert response.status_code == 200
assert "text/html" in response.headers["content-type"]

response = client.get(
"/mosaic/bbox/-74,45,-73,46.png",
params={"url": mosaic_file, "dst_crs": "EPSG:3857"},
)
assert response.status_code == 200
assert response.headers["content-type"] == "image/png"
assert response.headers["X-Assets"]
assert response.headers["Server-Timing"]
assert response.headers["Content-Crs"]
assert response.headers["Content-Bbox"]

meta = parse_img(response.content)
assert meta["width"] == 258
assert meta["height"] == 367

response = client.get(
"/mosaic/bbox/-74,45,-73,46/100x50.png",
params={"url": mosaic_file},
)
assert response.status_code == 200
assert response.headers["content-type"] == "image/png"
assert response.headers["X-Assets"]
assert response.headers["Server-Timing"]
assert response.headers["Content-Crs"]
assert response.headers["Content-Bbox"]

meta = parse_img(response.content)
assert meta["width"] == 100
assert meta["height"] == 50

# test /feature

feat = {
"type": "Polygon",
"coordinates": [
[
[-74, 45],
[-74, 46],
[-73, 46],
[-73, 45],
[-74, 45],
]
],
}
response = client.post(
"/mosaic/feature",
params={"url": mosaic_file},
json={"type": "Feature", "properties": {}, "geometry": feat},
)
assert response.status_code == 200
assert response.headers["content-type"] == "image/jpeg"
assert response.headers["X-Assets"]
assert response.headers["Server-Timing"]
assert response.headers["Content-Crs"]
assert response.headers["Content-Bbox"]

meta = parse_img(response.content)
assert meta["width"] == 301
assert meta["height"] == 301
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

those numbers feels weird, we might have an issue with the width/height calculation


response = client.post(
"/mosaic/feature",
params={"url": mosaic_file, "max_size": 200},
json={"type": "Feature", "properties": {}, "geometry": feat},
)
assert response.status_code == 200
assert response.headers["content-type"] == "image/jpeg"

meta = parse_img(response.content)
assert meta["width"] == 200
assert meta["height"] == 200

response = client.post(
"/mosaic/feature.png",
params={"url": mosaic_file},
json={"type": "Feature", "properties": {}, "geometry": feat},
)
assert response.status_code == 200
assert response.headers["content-type"] == "image/png"

response = client.post(
"/mosaic/feature/150x50.png",
params={"url": mosaic_file},
json={"type": "Feature", "properties": {}, "geometry": feat},
)
assert response.status_code == 200
assert response.headers["content-type"] == "image/png"
meta = parse_img(response.content)
assert meta["width"] == 150
assert meta["height"] == 50


@dataclass
class BackendParams(DefaultDependency):
Expand Down Expand Up @@ -346,8 +500,9 @@ def _multiply_by_two(data, mask):

def test_MosaicTilerFactory_PixelSelectionParams():
"""Test MosaicTilerFactory factory with a customized default PixelSelectionMethod."""
mosaic = MosaicTilerFactory(router_prefix="/mosaic")
mosaic = MosaicTilerFactory(backend=MosaicJSONBackend, router_prefix="/mosaic")
mosaic_highest = MosaicTilerFactory(
backend=MosaicJSONBackend,
pixel_selection_dependency=lambda: PixelSelectionMethod.highest.value,
router_prefix="/mosaic_highest",
)
Expand Down Expand Up @@ -381,7 +536,7 @@ def test_MosaicTilerFactory_PixelSelectionParams():
@patch("titiler.mosaic.factory.MOSAIC_STRICT_ZOOM", new=True)
def test_MosaicTilerFactory_strict_zoom():
"""Test MosaicTilerFactory factory with STRICT Zoom Mode"""
mosaic = MosaicTilerFactory()
mosaic = MosaicTilerFactory(backend=MosaicJSONBackend)
app = FastAPI()
app.include_router(mosaic.router)

Expand Down Expand Up @@ -417,7 +572,12 @@ class CustomBackend(FileBackend):
"""Custom FileBackend."""

def get_assets(
self, x: int, y: int, z: int, limit: Optional[int] = None
self,
x: int,
y: int,
z: int,
limit: Optional[int] = None,
**kwargs: Any,
) -> List[str]:
"""Find assets."""
assets = super().get_assets(x, y, z)
Expand Down
Loading