Extensions for TiTiler Factories.
Project description
titiler.extensions
Extent TiTiler Tiler Factories
Installation
python -m pip install -U pip
# From Pypi
python -m pip install titiler.extensions
# Or from sources
git clone https://github.com/developmentseed/titiler.git
cd titiler && python -m pip install -e src/titiler/core -e src/titiler/extensions
Available extensions
cogValidateExtension
- Goal: adds a
/validate
endpoint which return the content of rio-cogeoinfo
method - Additional requirements:
titiler.extensions["cogeo"]
cogViewerExtension
- Goal: adds a
/viewer
endpoint which return an HTML viewer for simple COGs
stacViewerExtension
- Goal: adds a
/viewer
endpoint which return an HTML viewer for STAC item
wmsExtension
- Goal: adds a
/wms
endpoint to support OGC Web Map Service (GetTile
andGetCapabilities
) specification
Use extensions
Extensions must be set at TilerFactory's creation using the extensions=
options.
from fastapi import FastAPI
from titiler.core.factory import TilerFactory
from titiler.extensions import cogValidateExtension
# Create a FastAPI application
app = FastAPI(description="A lightweight Cloud Optimized GeoTIFF tile server")
# Create a set of endpoints using TiTiler TilerFactory
tiler = TilerFactory(
router_prefix="/cog",
extensions=[
cogValidateExtension() # the cogeoExtension will add a rio-cogeo /validate endpoint
]
)
# Register endpoints to the application
app.include_router(tiler.router, prefix="/cog")
See titiler.application for a full example.
Create your own
from dataclasses import dataclass, field
from typing import Tuple, List, Optional
from starlette.responses import Response
from fastapi import Depends, FastAPI, Query
from titiler.core.factory import BaseTilerFactory, FactoryExtension, TilerFactory
from titiler.core.dependencies import RescalingParams
from titiler.core.factory import TilerFactory
from titiler.core.resources.enums import ImageType
@dataclass
class thumbnailExtension(FactoryExtension):
"""Add endpoint to a TilerFactory."""
# Set some options
max_size: int = field(default=128)
# Register method is mandatory and must take a BaseTilerFactory object as input
def register(self, factory: BaseTilerFactory):
"""Register endpoint to the tiler factory."""
# register an endpoint to the factory's router
@factory.router.get(
"/thumbnail",
responses={
200: {
"content": {
"image/png": {},
"image/jpeg": {},
},
"description": "Return an image.",
}
},
response_class=Response,
)
def thumbnail(
# we can reuse the factory dependency
src_path: str = Depends(factory.path_dependency),
layer_params=Depends(factory.layer_dependency),
dataset_params=Depends(factory.dataset_dependency),
post_process=Depends(factory.process_dependency),
rescale: Optional[List[Tuple[float, ...]]] = Depends(RescalingParams),
color_formula: Optional[str] = Query(
None,
title="Color Formula",
description="rio-color formula (info: https://github.com/mapbox/rio-color)",
),
colormap=Depends(factory.colormap_dependency),
render_params=Depends(factory.render_dependency),
reader_params=Depends(factory.reader_dependency),
env=Depends(factory.environment_dependency),
):
with rasterio.Env(**env):
with factory.reader(src_path, **reader_params) as src:
image = src.preview(
max_size=self.max_size,
**layer_params,
**dataset_params,
)
if post_process:
image = post_process(image)
if rescale:
image.rescale(rescale)
if color_formula:
image.apply_color_formula(color_formula)
format = ImageType.jpeg if image.mask.all() else ImageType.png
content = image.render(
img_format=format.driver,
colormap=colormap,
**format.profile,
**render_params,
)
return Response(content, media_type=format.mediatype)
# Use it
app = FastAPI()
tiler = TilerFactory(
extensions=[
thumbnailExtension(max_size=64)
]
)
app.include_router(tiler.router)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
titiler.extensions-0.19.1.tar.gz
(27.5 kB
view details)
Built Distribution
File details
Details for the file titiler.extensions-0.19.1.tar.gz
.
File metadata
- Download URL: titiler.extensions-0.19.1.tar.gz
- Upload date:
- Size: 27.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c33d8f3163225a0f2f2a55fedc83fa106787a8fcd4744d6b3c31568baa18a27c |
|
MD5 | 95b2ee92cc20b24f695c5bbf41d9239f |
|
BLAKE2b-256 | 6741b0a1870f7789163002aa689d3d54803b5a684566bd5f4fc57a1a18b9f57f |
File details
Details for the file titiler.extensions-0.19.1-py3-none-any.whl
.
File metadata
- Download URL: titiler.extensions-0.19.1-py3-none-any.whl
- Upload date:
- Size: 31.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94d734fd8463f8865eb9a79c9c66f04febf05d81541d5d0c53f50676da934bfe |
|
MD5 | bcbd7b4aa9bc051f131f0b60f3d91268 |
|
BLAKE2b-256 | a45d4366a34364e9aecbfa5235d5822dbaa686f98ea6c7aaa74a162e96b336fd |