factory

titiler.core.factory

TiTiler Router factories.

AlgorithmFactory

Bases: BaseFactory

Algorithm endpoints Factory.

_get_algo_metadata

_get_algo_metadata(algorithm: BaseAlgorithm) -> AlgorithmMetadata

Algorithm Metadata

register_routes

register_routes()

Register Algorithm routes.

BaseFactory

Base Factory.

Abstract Base Class which defines most inputs used by dynamic tiler.

Attributes:

• router (APIRouter) –

  Application router to register endpoints to.

• router_prefix (str) –

  prefix where the router will be mounted in the application.

• route_dependencies (list) –

  Additional routes dependencies to add after routes creations.

__attrs_post_init__

__attrs_post_init__()

Post Init: register route and configure specific options.

add_route_dependencies

add_route_dependencies(*, scopes: List[EndpointScope], dependencies=List[Depends])

Add dependencies to routes.

Allows a developer to add dependencies to a route after the route has been defined.

add_telemetry

add_telemetry()

Applies the factory_trace decorator to all registered API routes.

This method iterates through the router's routes and wraps the endpoint of each APIRoute to ensure consistent OpenTelemetry tracing.

register_routes abstractmethod

register_routes()

Register Routes.

url_for

url_for(request: Request, name: str, **path_params: Any) -> str

Return full url (with prefix) for a specific endpoint.

ColorMapFactory

Bases: BaseFactory

Colormap endpoints Factory.

_image_from_colormap

_image_from_colormap(
    cmap,
    orientation: Optional[Literal["vertical", "horizontal"]] = None,
    width: Optional[int] = None,
    height: Optional[int] = None,
) -> ImageData

Create an image from a colormap.

register_routes

register_routes()

Register ColorMap routes.

FactoryExtension

Factory Extension.

register abstractmethod

register(factory: BaseFactory)

Register extension to the factory.

MultiBandTilerFactory

Bases: TilerFactory

Custom Tiler Factory for MultiBandReader classes.

Note

To be able to use the rio_tiler.io.MultiBandReader we need to be able to pass a bands argument to most of its methods. By using the BandsExprParams for the layer_dependency, the .tile(), .point(), .preview() and the .part() methods will receive bands or expression arguments.

The rio_tiler.io.MultiBandReader .info() and .metadata() have bands as a requirement arguments (github.com/cogeotiff/rio-tiler/blob/main/rio_tiler/io/base.py#L775). This means we have to update the /info and /metadata endpoints in order to add the bands dependency.

For implementation example see developmentseed/titiler-pds

info

info()

Register /info endpoint.

statistics

statistics()

add statistics endpoints.

MultiBaseTilerFactory

Bases: TilerFactory

Custom Tiler Factory for MultiBaseReader classes.

Note

To be able to use the rio_tiler.io.MultiBaseReader we need to be able to pass a assets argument to most of its methods. By using the AssetsBidxExprParams for the layer_dependency, the .tile(), .point(), .preview() and the .part() methods will receive assets, expression or indexes arguments.

The rio_tiler.io.MultiBaseReader .info() and .metadata() have assets as a requirement arguments (github.com/cogeotiff/rio-tiler/blob/main/rio_tiler/io/base.py#L365). This means we have to update the /info and /metadata endpoints in order to add the assets dependency.

info

info()

Register /info endpoint.

statistics

statistics()

Register /statistics endpoint.

TMSFactory

Bases: BaseFactory

TileMatrixSet endpoints Factory.

register_routes

register_routes()

Register TMS endpoint routes.

TilerFactory

Bases: BaseFactory

Tiler Factory.

Attributes:

• reader (BaseReader) –

  A rio-tiler reader. Defaults to rio_tiler.io.Reader.

• reader_dependency (DefaultDependency) –

  Endpoint dependency defining BaseReader options.

• path_dependency (Callable) –

  Endpoint dependency defining path to pass to the reader init.

• layer_dependency (DefaultDependency) –

  Endpoint dependency defining dataset indexes/bands/assets options.

• dataset_dependency (DefaultDependency) –

  Endpoint dependency defining dataset overwriting options (e.g nodata).

• tile_dependency (DefaultDependency) –

  Endpoint dependency defining tile options (e.g buffer, padding).

• stats_dependency (DefaultDependency) –

  Endpoint dependency defining options for rio-tiler's statistics method.

• histogram_dependency (DefaultDependency) –

  Endpoint dependency defining options for numpy's histogram method.

• img_preview_dependency (DefaultDependency) –

  Endpoint dependency defining options for rio-tiler's preview method.

• img_part_dependency (DefaultDependency) –

  Endpoint dependency defining options for rio-tiler's part/feature methods.

• process_dependency (DefaultDependency) –

  Endpoint dependency defining image post-processing options (e.g rescaling, color-formula).

• rescale_dependency (Callable[..., Optional[RescaleType]]) –
• color_formula_dependency (Callable[..., Optional[str]]) –
• colormap_dependency (Callable) –

  Endpoint dependency defining ColorMap options (e.g colormap_name).

• render_dependency (DefaultDependency) –

  Endpoint dependency defining image rendering options (e.g add_mask).

• environment_dependency (Callable) –

  Endpoint dependency to define GDAL environment at runtime.

• supported_tms (TileMatrixSets) –

  TileMatrixSets object holding the supported TileMatrixSets.

• templates (Jinja2Templates) –

  Jinja2 templates.

• add_preview (bool) –

  add /preview endpoints. Defaults to True.

• add_part (bool) –

  add /bbox and /feature endpoints. Defaults to True.

• add_viewer (bool) –

  add /map.html endpoints. Defaults to True.

info

info()

Register /info endpoint.

map_viewer

map_viewer()

Register /map.html endpoint.

ogc_maps

ogc_maps()

Register OGC Maps /map` endpoint.

part

part()

Register /bbox and /feature endpoints.

point

point()

Register /point endpoints.

preview

preview()

Register /preview endpoint.

register_routes

register_routes()

This Method register routes to the router.

Because we wrap the endpoints in a class we cannot define the routes as methods (because of the self argument). The HACK is to define routes inside the class method and register them after the class initialization.

statistics

statistics()

add statistics endpoints.

tile

tile()

Register /tiles endpoint.

tilejson

tilejson()

Register /tilejson.json endpoint.

tilesets

tilesets()

Register OGC tilesets endpoints.