Tiler Factories

TiTiler.PgSTAC provides a MosaicTilerFactory factory which is an helper functions to create FastAPI router (fastapi.APIRouter) with a minimal set of endpoints.

titiler.pgstac.factory.MosaicTilerFactory

# Minimal PgSTAC Mosaic Application
from contextlib import asynccontextmanager

from fastapi import FastAPI
from titiler.pgstac.db import close_db_connection, connect_to_db
from titiler.pgstac.factory import MosaicTilerFactory

@asynccontextmanager
async def lifespan(app: FastAPI):
    """FastAPI Lifespan."""
    # Create Connection Pool
    await connect_to_db(app)
    yield
    # Close the Connection Pool
    await close_db_connection(app)


app = FastAPI(lifespan=lifespan)

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

Method	URL	Output	Description
POST	/register	JSON (Register)	Register Search query OPTIONAL
GET	/list	JSON (Info)	Return Search query infos OPTIONAL
GET	/{searchid}/info	JSON (Infos)	Return list of Search entries with Mosaic type OPTIONAL
GET	/{searchid}/{lon},{lat}/assets	JSON	Return a list of assets which overlap a given point
GET	/{searchid}/tiles[/{TileMatrixSetId}]/{z}/{x}/{Y}/assets	JSON	Return a list of assets which overlap a given tile
GET	/{searchid}/tiles[/{TileMatrixSetId}]/{z}/{x}/{y}[@{scale}x][.{format}]	image/bin	Create a web map tile image for a search query and a tile index
GET	/{searchid}[/{TileMatrixSetId}]/tilejson.json	JSON (TileJSON)	Return a Mapbox TileJSON document
GET	/{searchid}[/{TileMatrixSetId}]/WMTSCapabilities.xml	XML	return OGC WMTS Get Capabilities
GET	/{searchid}[/{TileMatrixSetId}]/map	HTML	simple map viewer OPTIONAL
POST	/{searchid}/statistics	GeoJSON (Statistics)	Return statistics for geojson features OPTIONAL

Item

For the single STAC item endpoints we use TiTiler's MultiBaseTilerFactory with a custom path_dependency to use item and collection path parameter (instead of the default url query param).

This custom path_dependency will connect to PgSTAC directly to fetch the STAC Item and pass it to a custom Reader based on rio_tiler.io.MultiBaseReader.

# Minimal PgSTAC Item Application
from contextlib import asynccontextmanager

from fastapi import FastAPI

from titiler.core.factory import MultiBaseTilerFactory

from titiler.pgstac.db import close_db_connection, connect_to_db
from titiler.pgstac.dependencies import ItemPathParams
from titiler.pgstac.reader import PgSTACReader


@asynccontextmanager
async def lifespan(app: FastAPI):
    """FastAPI Lifespan."""
    # Create Connection Pool
    await connect_to_db(app)
    yield
    # Close the Connection Pool
    await close_db_connection(app)


app = FastAPI(lifespan=lifespan)

item = MultiBaseTilerFactory(
    reader=PgSTACReader,
    path_dependency=ItemPathParams,
    router_prefix="/collections/{collection_id}/items/{item_id}",
)
app.include_router(item.router, prefix="/collections/{collection_id}/items/{item_id}")