add dst-crs (#647)

Author: vincentsarago

CHANGES.md

@@ -6,6 +6,8 @@
 
 * make HTML `templates` configurable in the factories
 * rename `index.html` to `map.html`
+* rename `dependencies.CRSParams` to `dependencies.CoordCRSParams`
+* add `dst-crs` option for `/preview` and `/crop` endpoints to specify the output Coordinate Reference System.
 
 ### titiler.mosaic
 

CONTRIBUTING.md

@@ -24,6 +24,24 @@ This repo is set to use `pre-commit` to run *isort*, *flake8*, *pydocstring*, *b
 pre-commit install
 ```
 
+### Run tests
+
+Each `titiler`'s modules has its own test suite which can be ran independently
+
+```
+# titiler.core
+python -m pytest src/titiler/core --cov=titiler.core --cov-report=xml --cov-append --cov-report=term-missing
+
+# titiler.extensions
+python -m pytest src/titiler/extensions --cov=titiler.extensions --cov-report=xml --cov-append --cov-report=term-missing
+
+# titiler.mosaic
+python -m pytest src/titiler/mosaic --cov=titiler.mosaic --cov-report=xml --cov-append --cov-report=term-missing
+
+# titiler.application
+python -m pytest src/titiler/application --cov=titiler.application --cov-report=xml --cov-append --cov-report=term-missing
+```
+
 ### Docs
 
 ```bash

src/titiler/core/tests/test_factories.py

@@ -16,6 +16,7 @@
 import numpy
 from fastapi import Depends, FastAPI, HTTPException, Path, Query, security, status
 from morecantile.defaults import TileMatrixSets
+from rasterio.crs import CRS
 from rasterio.io import MemoryFile
 from rio_tiler.io import BaseReader, MultiBandReader, Reader, STACReader
 from starlette.requests import Request
@@ -1553,3 +1554,54 @@ def custom_rescale_params() -> Optional[RescaleType]:
         assert response.headers["content-type"] == "application/x-binary"
         numpy.load(BytesIO(response.content))
         assert npy_tile.shape == (2, 256, 256)  # mask + data
+
+
+def test_dst_crs_option():
+    """test dst-crs parameter."""
+    app = FastAPI()
+    app.include_router(TilerFactory().router)
+
+    with TestClient(app) as client:
+        # preview endpoints
+        response = client.get(f"/preview.tif?url={DATA_DIR}/cog.tif")
+        assert response.status_code == 200
+        assert response.headers["content-type"] == "image/tiff; application=geotiff"
+        meta = parse_img(response.content)
+        assert meta["crs"] == CRS.from_epsg(
+            32621
+        )  # return the image in the original CRS
+
+        response = client.get(f"/preview.tif?url={DATA_DIR}/cog.tif&dst-crs=epsg:4326")
+        meta = parse_img(response.content)
+        assert meta["crs"] == CRS.from_epsg(4326)
+        assert not meta["crs"] == CRS.from_epsg(32621)
+
+        # /crop endpoints
+        response = client.get(
+            f"/crop/-56.228,72.715,-54.547,73.188.tif?url={DATA_DIR}/cog.tif"
+        )
+        meta = parse_img(response.content)
+        assert meta["crs"] == CRS.from_epsg(
+            4326
+        )  # default is to return image in the bounds-crs
+        assert not meta["crs"] == CRS.from_epsg(32621)
+
+        # Force output in epsg:32621
+        response = client.get(
+            f"/crop/-56.228,72.715,-54.547,73.188.tif?url={DATA_DIR}/cog.tif&dst-crs=epsg:32621"
+        )
+        meta = parse_img(response.content)
+        assert meta["crs"] == CRS.from_epsg(32621)
+
+        # coord-crs + dst-crs
+        response = client.get(
+            f"/crop/-6259272.328324187,12015838.020930404,-6072144.264300693,12195445.265479913.tif?url={DATA_DIR}/cog.tif&coord-crs=epsg:3857"
+        )
+        meta = parse_img(response.content)
+        assert meta["crs"] == CRS.from_epsg(3857)
+
+        response = client.get(
+            f"/crop/-6259272.328324187,12015838.020930404,-6072144.264300693,12195445.265479913.tif?url={DATA_DIR}/cog.tif&coord-crs=epsg:3857&dst-crs=epsg:32621"
+        )
+        meta = parse_img(response.content)
+        assert meta["crs"] == CRS.from_epsg(32621)

src/titiler/core/titiler/core/dependencies.py

@@ -451,7 +451,7 @@ def __post_init__(self):
             self.range = list(map(float, self.range.split(",")))  # type: ignore
 
 
-def CRSParams(
+def CoordCRSParams(
     crs: str = Query(
         None,
         alias="coord-crs",
@@ -463,3 +463,17 @@ def CRSParams(
         return CRS.from_user_input(crs)
 
     return None
+
+
+def DstCRSParams(
+    crs: str = Query(
+        None,
+        alias="dst-crs",
+        description="Output Coordinate Reference System.",
+    )
+) -> Optional[CRS]:
+    """Coordinate Reference System Coordinates Param."""
+    if crs:
+        return CRS.from_user_input(crs)
+
+    return None

src/titiler/core/titiler/core/factory.py

@@ -38,10 +38,11 @@
     BandsParams,
     BidxExprParams,
     ColorMapParams,
-    CRSParams,
+    CoordCRSParams,
     DatasetParams,
     DatasetPathParams,
     DefaultDependency,
+    DstCRSParams,
     HistogramParams,
     ImageParams,
     ImageRenderingParams,
@@ -431,7 +432,7 @@ def geojson_statistics(
                 ..., description="GeoJSON Feature or FeatureCollection."
             ),
             src_path=Depends(self.path_dependency),
-            coord_crs: Optional[CRS] = Depends(CRSParams),
+            coord_crs: Optional[CRS] = Depends(CoordCRSParams),
             layer_params=Depends(self.layer_dependency),
             dataset_params=Depends(self.dataset_dependency),
             image_params=Depends(self.img_dependency),
@@ -850,7 +851,7 @@ def point(
             lon: float = Path(..., description="Longitude"),
             lat: float = Path(..., description="Latitude"),
             src_path=Depends(self.path_dependency),
-            coord_crs: Optional[CRS] = Depends(CRSParams),
+            coord_crs: Optional[CRS] = Depends(CoordCRSParams),
             layer_params=Depends(self.layer_dependency),
             dataset_params=Depends(self.dataset_dependency),
             reader_params=Depends(self.reader_dependency),
@@ -888,8 +889,9 @@ def preview(
             ),
             src_path=Depends(self.path_dependency),
             layer_params=Depends(self.layer_dependency),
+            dst_crs: Optional[CRS] = Depends(DstCRSParams),
             dataset_params=Depends(self.dataset_dependency),
-            img_params=Depends(self.img_dependency),
+            image_params=Depends(self.img_dependency),
             post_process=Depends(self.process_dependency),
             rescale=Depends(self.rescale_dependency),  # noqa
             color_formula: Optional[str] = Query(
@@ -907,8 +909,9 @@ def preview(
                 with self.reader(src_path, **reader_params) as src_dst:
                     image = src_dst.preview(
                         **layer_params,
-                        **img_params,
+                        **image_params,
                         **dataset_params,
+                        dst_crs=dst_crs,
                     )
                     dst_colormap = getattr(src_dst, "colormap", None)
 
@@ -957,7 +960,8 @@ def part(
             maxy: float = Path(..., description="Bounding box max Y"),
             format: ImageType = Query(..., description="Output image type."),
             src_path=Depends(self.path_dependency),
-            coord_crs: Optional[CRS] = Depends(CRSParams),
+            dst_crs: Optional[CRS] = Depends(DstCRSParams),
+            coord_crs: Optional[CRS] = Depends(CoordCRSParams),
             layer_params=Depends(self.layer_dependency),
             dataset_params=Depends(self.dataset_dependency),
             image_params=Depends(self.img_dependency),
@@ -978,6 +982,7 @@ def part(
                 with self.reader(src_path, **reader_params) as src_dst:
                     image = src_dst.part(
                         [minx, miny, maxx, maxy],
+                        dst_crs=dst_crs,
                         bounds_crs=coord_crs or WGS84_CRS,
                         **layer_params,
                         **image_params,
@@ -1024,7 +1029,7 @@ def geojson_crop(
                 None, description="Output image type. Default is auto."
             ),
             src_path=Depends(self.path_dependency),
-            coord_crs: Optional[CRS] = Depends(CRSParams),
+            coord_crs: Optional[CRS] = Depends(CoordCRSParams),
             layer_params=Depends(self.layer_dependency),
             dataset_params=Depends(self.dataset_dependency),
             image_params=Depends(self.img_dependency),
@@ -1267,7 +1272,7 @@ def geojson_statistics(
                 ..., description="GeoJSON Feature or FeatureCollection."
             ),
             src_path=Depends(self.path_dependency),
-            coord_crs: Optional[CRS] = Depends(CRSParams),
+            coord_crs: Optional[CRS] = Depends(CoordCRSParams),
             layer_params=Depends(AssetsBidxExprParamsOptional),
             dataset_params=Depends(self.dataset_dependency),
             image_params=Depends(self.img_dependency),
@@ -1460,7 +1465,7 @@ def geojson_statistics(
                 ..., description="GeoJSON Feature or FeatureCollection."
             ),
             src_path=Depends(self.path_dependency),
-            coord_crs: Optional[CRS] = Depends(CRSParams),
+            coord_crs: Optional[CRS] = Depends(CoordCRSParams),
             bands_params=Depends(BandsExprParamsOptional),
             dataset_params=Depends(self.dataset_dependency),
             image_params=Depends(self.img_dependency),