update docs

Author: vincentsarago

docs/mkdocs.yml

@@ -116,13 +116,15 @@ nav:
     - titiler.mosaic:
       - factory: api/titiler/mosaic/factory.md
       - errors: api/titiler/mosaic/errors.md
+      - extensions: api/titiler/mosaic/extensions.md
       - models:
         - responses: api/titiler/mosaic/models/responses.md
     - titiler.xarray:
       - io: api/titiler/xarray/io.md
       - dependencies: api/titiler/xarray/dependencies.md
       - extensions: api/titiler/xarray/extensions.md
       - factory: api/titiler/xarray/factory.md
+      - main: api/titiler/xarray/main.md
 
   - Deployment:
     - Amazon Web Services:

docs/src/advanced/Extensions.md

@@ -63,6 +63,10 @@ class FactoryExtension(metaclass=abc.ABCMeta):
 
 - Goal: adds `/dataset/`, `/dataset/keys` and `/datasets/dict` endpoints which return metadata about a multidimensional Dataset (not a DataArray)
 
+#### titiler.mosaic.extensions.MosaicJSONExtension
+
+- Goal: adds `/` and `/validate` endpoints to return MosaicJSON content and validate external mosaics.
+
 ## How To
 
 ### Use extensions

docs/src/advanced/customization.md

@@ -95,9 +95,11 @@ COGTilerWithCustomTMS = TilerFactory(supported_tms=tms)
 ### Add a MosaicJSON creation endpoint
 ```python
 
-from dataclasses import dataclass
 from typing import List, Optional
 
+from attrs import define
+
+from cogeo_mosaic.backends import MosaicBackend as MosaicJSONBackend
 from titiler.mosaic.factory import MosaicTilerFactory
 from titiler.core.errors import BadRequestError
 from cogeo_mosaic.mosaic import MosaicJSON
@@ -128,9 +130,11 @@ class UpdateMosaicJSON(BaseModel):
     add_first: bool = True
 
 
-@dataclass
+@define(kw_only=True)
 class CustomMosaicFactory(MosaicTilerFactory):
 
+    backend: Type[MosaicJSONBackend] = MosaicJSONBackend
+
     def register_routes(self):
         """Update the class method to add create/update"""
         super().register_routes()
@@ -162,8 +166,10 @@ class CustomMosaicFactory(MosaicTilerFactory):
 
             # Write the MosaicJSON using a cogeo-mosaic backend
             with rasterio.Env(**env):
-                with self.reader(
-                    body.url, mosaic_def=mosaic, reader=self.dataset_reader
+                with self.backend(
+                    body.url, 
+                    mosaic_def=mosaic, 
+                    reader=self.dataset_reader
                 ) as mosaic:
                     try:
                         mosaic.write(overwrite=body.overwrite)
@@ -185,7 +191,7 @@ class CustomMosaicFactory(MosaicTilerFactory):
         ):
             """Update an existing MosaicJSON"""
             with rasterio.Env(**env):
-                with self.reader(body.url, reader=self.dataset_reader) as mosaic:
+                with self.backend(body.url, reader=self.dataset_reader) as mosaic:
                     features = get_footprints(body.files, max_threads=body.max_threads)
                     try:
                         mosaic.update(features, add_first=body.add_first, quiet=True)

docs/src/advanced/endpoints_factories.md

@@ -301,35 +301,39 @@ app.include_router(colormap.router)
 
 class: `titiler.mosaic.factory.MosaicTilerFactory`
 
-Endpoints factory for mosaics, built on top of [MosaicJSON](https://github.com/developmentseed/mosaicjson-spec).
+Endpoints factory for mosaics.
 
 #### Attributes
 
-- **backend**: `cogeo_mosaic.backends.BaseBackend` Mosaic backend. Defaults to `cogeo_mosaic.backend.MosaicBackend`.
+- **backend**: `rio_tiler.mosaic.backends.BaseBackend` Mosaic backend.
 - **backend_dependency**: Dependency to control options passed to the backend instance init. Defaults to `titiler.core.dependencies.DefaultDependency`
 - **dataset_reader**: Dataset Reader. Defaults to `rio_tiler.io.Reader`
 - **reader_dependency**: Dependency to control options passed to the reader instance init. Defaults to `titiler.core.dependencies.DefaultDependency`
-- **path_dependency**: Dependency to use to define the dataset url. Defaults to `titiler.mosaic.factory.DatasetPathParams`.
+- **path_dependency**: Dependency to use to define the dataset. Defaults to `titiler.mosaic.factory.DatasetPathParams`.
 - **assets_accessor_dependency**: Dependency to define options to be forwarded to the backend `get_assets` method. Defaults to `titiler.core.dependencies.DefaultDependency`.
 - **layer_dependency**: Dependency to define band indexes or expression. Defaults to `titiler.core.dependencies.BidxExprParams`.
 - **dataset_dependency**: Dependency to overwrite `nodata` value, apply `rescaling` and change the `I/O` or `Warp` resamplings. Defaults to `titiler.core.dependencies.DatasetParams`.
 - **tile_dependency**: Dependency to define `buffer` and `padding` to apply at tile creation. Defaults to `titiler.core.dependencies.TileParams`.
 - **process_dependency**: Dependency to control which `algorithm` to apply to the data. Defaults to `titiler.core.algorithm.algorithms.dependency`.
+- **stats_dependency**: Dependency to define options for *rio-tiler*'s statistics method used in `/statistics` endpoints. Defaults to `titiler.core.dependencies.StatisticsParams`.
+- **histogram_dependency**: Dependency to define *numpy*'s histogram options used in `/statistics` endpoints. Defaults to `titiler.core.dependencies.HistogramParams`.
 - **colormap_dependency**: Dependency to define the Colormap options. Defaults to `titiler.core.dependencies.ColorMapParams`
 - **render_dependency**: Dependency to control output image rendering options. Defaults to `titiler.core.dependencies.ImageRenderingParams`
 - **pixel_selection_dependency**: Dependency to select the `pixel_selection` method. Defaults to `titiler.mosaic.factory.PixelSelectionParams`.
 - **environment_dependency**: Dependency to define GDAL environment at runtime. Default to `lambda: {}`.
 - **supported_tms**: List of available TileMatrixSets. Defaults to `morecantile.tms`.
-- **supported_tms**: List of available TileMatrixSets. Defaults to `morecantile.tms`.
-- **templates**: *Jinja2* templates to use in endpoints. Defaults to `titiler.core.factory.DEFAULT_TEMPLATES`.
+- **render_func**: Image rendering method. Defaults to `titiler.core.utils.render_image`.
 - **optional_headers**: List of OptionalHeader which endpoints could add (if implemented). Defaults to `[]`.
+- **templates**: *Jinja2* templates to use in endpoints. Defaults to `titiler.core.factory.DEFAULT_TEMPLATES`.
 - **add_viewer**: Add `/{TileMatrixSetId}/map.html` endpoints to the router. Defaults to `True`.
+- **add_statistics**: Add `POST - /statistics` endpoints to the router. Defaults to `False`.
+- **add_part**: Add `/bbox` and `/feature` endpoints to the router. Defaults to `False`.
+- **conforms_to**: Set of conformance classes the Factory implement
 
 #### Endpoints
 
 | Method | URL                                                             | Output                                             | Description
 | ------ | --------------------------------------------------------------- |--------------------------------------------------- |--------------
-| `GET`  | `/`                                                             | JSON [MosaicJSON][mosaic_model]                    | return a MosaicJSON document
 | `GET`  | `/info`                                                         | JSON ([Info][mosaic_info_model])                   | return mosaic's basic info
 | `GET`  | `/info.geojson`                                                 | GeoJSON ([InfoGeoJSON][mosaic_geojson_info_model]) | return mosaic's basic info  as a GeoJSON feature
 | `GET`  | `/tiles`                                                        | JSON                                               | List of OGC Tilesets available
@@ -342,6 +346,30 @@ Endpoints factory for mosaics, built on top of [MosaicJSON](https://github.com/d
 | `GET`  | `/point/{lon},{lat}`                                            | JSON ([Point][mosaic_point])                       | return pixel value from a MosaicJSON dataset
 | `GET`  | `/point/{lon},{lat}/assets`                                     | JSON                                               | return list of assets intersecting a point
 | `GET`  | `/bbox/{minx},{miny},{maxx},{maxy}/assets`                      | JSON                                               | return list of assets intersecting a bounding box
+| `POST` | `/statistics`                                                   | GeoJSON ([Statistics][stats_geojson_model])        | return info and statistics for a dataset **Optional**
+| `GET`  | `/bbox/{minx},{miny},{maxx},{maxy}[/{width}x{height}].{format}` | image/bin                                          | create an image from part of a dataset **Optional**
+| `POST` | `/feature[/{width}x{height}][.{format}]`                        | image/bin                                          | create an image from a geojson feature **Optional**
+
+
+```python
+from fastapi import FastAPI
+
+from titiler.mosaic.factory import MosaicTilerFactory
+from cogeo_mosaic.backends import MosaicBackend as MosaicJSONBackend
+
+# Create FastAPI application
+app = FastAPI()
+
+# Create router and register set of endpoints
+mosaic = TilerFactory(
+    backend=MosaicJSONBackend,
+    add_part=True,     # default to False
+    add_statistics=True,  # default to False
+)
+
+# add router endpoint to the main application
+app.include_router(mosaic.router)
+```
 
 ## titiler.xarray
 

docs/src/api/titiler/mosaic/extensions.md

@@ -0,0 +1 @@
+::: titiler.mosaic.extensions

docs/src/api/titiler/xarray/main.md

@@ -0,0 +1 @@
+::: titiler.xarray.main

src/titiler/mosaic/README.md

@@ -2,11 +2,7 @@
 
 <img style="max-width:400px" src="https://github.com/user-attachments/assets/14b92588-14eb-4b37-b862-cc5d0d8015c9"/>
 
-Adds support for [MosaicJSON](https://github.com/developmentseed/mosaicjson-spec) in Titiler.
-
-> MosaicJSON is an open standard for representing metadata about a mosaic of Cloud-Optimized GeoTIFF (COG) files.
-
-Ref: https://github.com/developmentseed/mosaicjson-spec
+Adds support for Mosaic in Titiler. `Mosaic's` backend needs to be built on top of rio-tiler's Mosaic Backend https://cogeotiff.github.io/rio-tiler/advanced/mosaic_backend/
 
 ## Installation
 
@@ -19,6 +15,9 @@ python -m pip install titiler.mosaic
 # Or from sources
 git clone https://github.com/developmentseed/titiler.git
 cd titiler && python -m pip install -e src/titiler/core -e src/titiler/mosaic
+
+# install cogeo-mosaic for MosaicJSON support
+python -m pip install cogeo-mosaic
 ```
 
 ## How To
@@ -27,13 +26,15 @@ cd titiler && python -m pip install -e src/titiler/core -e src/titiler/mosaic
 from fastapi import FastAPI
 from titiler.mosaic.factory import MosaicTilerFactory
 
+from cogeo_mosaic.backends import MosaicBackend
+
 # Create a FastAPI application
 app = FastAPI(
     description="A Mosaic tile server",
 )
 
-# Create a set of MosaicJSON endpoints
-mosaic = MosaicTilerFactory()
+# Create a set of Mosaic endpoints using MosaicJSON backend from cogeo-mosaic project
+mosaic = MosaicTilerFactory(backend=MosaicBackend)
 
 # Register the Mosaic endpoints to the application
 app.include_router(mosaic.router, tags=["MosaicJSON"])
@@ -48,6 +49,7 @@ titiler/
     └── titiler/mosaic/          - `mosaic` namespace package
         ├── models/
         |   └── responses.py     - mosaic response models
-        ├── errors.py            - cogeo-mosaic known errors
+        ├── errors.py            - mosaic known errors
+        ├── extensions.py        - extensions
         └── factory.py           - Mosaic endpoints factory
 ```

src/titiler/xarray/titiler/xarray/io.py

@@ -209,7 +209,6 @@ def get_variable(
         ds (xarray.Dataset): Xarray Dataset.
         variable (str): Variable to extract from the Dataset.
         sel (list of str, optional): List of Xarray Indexes.
-        method (str): Xarray indexing method.
 
     Returns:
         xarray.DataArray: 2D or 3D DataArray.