Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: STAC Render Extension support #1038

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat: STAC Render Extension support #1038

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
529d864
Render Extension
emmanuelmathot Nov 19, 2024
e20dfef
feat(stac): add render extenstions support
alekzvik Nov 26, 2024
c63a482
remove unnecessary item.json file
alekzvik Nov 26, 2024
3f10def
Rework the response structure to include links.
alekzvik Nov 26, 2024
9904786
rename renderExtension -> stacRenderExtension
alekzvik Nov 26, 2024
a7121b2
add tests for stacRenderExtension
alekzvik Nov 26, 2024
3e9995e
add test for extra param
alekzvik Nov 26, 2024
767c31d
docs and docstrings
alekzvik Nov 26, 2024
46b13ee
fix typing in python 3.8
alekzvik Nov 26, 2024
8dbdcf6
Move out query params validation
alekzvik Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/src/advanced/Extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ class FactoryExtension(metaclass=abc.ABCMeta):

- Goal: adds a `/wms` endpoint to support OGC WMS specification (`GetCapabilities` and `GetMap`)

#### stacRenderExtenstion
- Goal: adds a `/render` and `/render/{render_id}` endpoints which return the contents of [STAC render extension](https://github.com/stac-extensions/render) and links to tileset.json and WMTS service

## How To

### Use extensions
Expand Down
2 changes: 1 addition & 1 deletion src/titiler/application/tests/routes/test_stac.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""test /COG endpoints."""
"""test /stac endpoints."""


from typing import Dict
Expand Down
2 changes: 2 additions & 0 deletions src/titiler/application/titiler/application/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
cogValidateExtension,
cogViewerExtension,
stacExtension,
stacRenderExtension,
stacViewerExtension,
)
from titiler.mosaic.errors import MOSAIC_STATUS_CODES
Expand Down Expand Up @@ -122,6 +123,7 @@ def validate_access_token(access_token: str = Security(api_key_query)):
router_prefix="/stac",
extensions=[
stacViewerExtension(),
stacRenderExtension(),
],
)

Expand Down
324 changes: 324 additions & 0 deletions src/titiler/extensions/tests/fixtures/render_item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,324 @@
{
"type": "Feature",
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/eo/v1.0.0/schema.json",
"https://stac-extensions.github.io/projection/v1.0.0/schema.json",
"https://stac-extensions.github.io/view/v1.0.0/schema.json",
"https://stac-extensions.github.io/render/v2.0.0/schema.json",
"https://stac-extensions.github.io/virtual-assets/v1.0.0/schema.json",
"https://stac-extensions.github.io/web-map-links/v1.2.0/schema.json"
],
"id": "LC08_L1TP_044033_20210305_20210312_01_T1",
"properties": {
"gsd": 30,
"platform": "LANDSAT_8",
"instruments": [
"OLI",
"TIRS"
],
"eo:cloud_cover": 7.41,
"proj:epsg": 32610,
"view:sun_azimuth": 149.10910644,
"view:sun_elevation": 40.48243563,
"view:off_nadir": 0.001,
"landsat:scene_id": "LC80440332021064LGN00",
"landsat:processing_level": "L1TP",
"landsat:collection_number": "01",
"landsat:collection_category": "T1",
"landsat:cloud_cover_land": 7.4,
"landsat:wrs_path": "44",
"landsat:wrs_row": "33",
"datetime": "2021-03-05T18:45:37.619485Z",
"created": "2021-03-16T01:40:56.703Z",
"updated": "2021-03-16T01:40:56.703Z",
"renders": {
"thumbnail": {
"title": "Thumbnail",
"assets": [
"B4",
"B3",
"B2"
],
"rescale": [
[
0,
150
]
],
"colormap_name": "rainbow",
"resampling": "bilinear",
"bidx": [
1
],
"width": 1024,
"height": 1024,
"bands": [
"B4",
"B3",
"B2"
]
},
"ndvi": {
"title": "Normalized Difference Vegetation Index",
"assets": [
"ndvi"
],
"resampling": "average",
"colormap_name": "ylgn",
"extra_param": "that titiler does not know"
}
}
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.49680286164214,
39.958062660227306
],
[
-120.31547276090922,
39.578858170656
],
[
-120.82135075676177,
37.82701417652536
],
[
-122.9993441554352,
38.2150173967007
],
[
-122.49680286164214,
39.958062660227306
]
]
]
},
"links": [
{
"href": "https://maps.example.com/xyz/{z}/{x}/{y}.png",
"rel": "xyz",
"type": "image/png",
"title": "RGB composite visualized through a XYZ"
},
{
"rel": "xyz",
"type": "image/png",
"title": "NDVI",
"href": "https://api.cogeo.xyz/stac/preview.png?url=https://raw.githubusercontent.com/stac-extensions/raster/main/examples/item-landsat8.json&expression=(B5–B4)/(B5+B4)&max_size=512&width=512&resampling_method=average&rescale=-1,1&color_map=ylgn&return_mask=true",
"render": "ndvi"
},
{
"rel": "collection",
"href": "https://landsat-stac.s3.amazonaws.com/collections/landsat-8-l1.json",
"type": "application/json",
"title": "The full collection"
}
],
"assets": {
"index": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/index.html",
"type": "application/html",
"title": "HTML Page"
},
"ANG": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_ANG.txt",
"type": "text/plain",
"title": "ANG Metadata",
"roles": [
"metadata"
]
},
"MTL": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_MTL.txt",
"type": "text/plain",
"title": "MTL Metadata",
"roles": [
"metadata"
]
},
"BQA": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_BQA.TIF",
"type": "image/tiff; application=geotiff",
"title": "Quality Band",
"roles": [
"quality"
]
},
"B1": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B1.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B1",
"common_name": "coastal",
"center_wavelength": 0.48,
"full_width_half_max": 0.02
}
]
},
"B2": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B2.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B2",
"common_name": "blue",
"center_wavelength": 0.44,
"full_width_half_max": 0.06
}
]
},
"B3": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B3.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B3",
"common_name": "green",
"center_wavelength": 0.56,
"full_width_half_max": 0.06
}
]
},
"B4": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B4.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B4",
"common_name": "red",
"center_wavelength": 0.65,
"full_width_half_max": 0.04
}
]
},
"B5": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B5.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B5",
"common_name": "nir",
"center_wavelength": 0.86,
"full_width_half_max": 0.03
}
]
},
"B6": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B6.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B6",
"common_name": "swir16",
"center_wavelength": 1.6,
"full_width_half_max": 0.08
}
]
},
"B7": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B7.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B7",
"common_name": "swir22",
"center_wavelength": 2.2,
"full_width_half_max": 0.2
}
]
},
"B8": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B8.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B8",
"common_name": "pan",
"center_wavelength": 0.59,
"full_width_half_max": 0.18
}
],
"gsd": 15
},
"B9": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B9.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B9",
"common_name": "cirrus",
"center_wavelength": 1.37,
"full_width_half_max": 0.02
}
]
},
"B10": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B10.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B10",
"common_name": "lwir11",
"center_wavelength": 10.9,
"full_width_half_max": 0.8
}
],
"gsd": 100
},
"B11": {
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1/LC08_L1TP_044033_20210305_20210312_01_T1_B11.TIF",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"eo:bands": [
{
"name": "B11",
"common_name": "lwir12",
"center_wavelength": 12,
"full_width_half_max": 1
}
],
"gsd": 100
},
"ndvi": {
"roles": [
"virtual",
"data",
"index"
],
"type": "image/vnd.stac.geotiff; cloud-optimized=true",
"href": "https://landsat-pds.s3.us-west-2.amazonaws.com/c1/L8/044/033/LC08_L1TP_044033_20210305_20210312_01_T1#/assets/NDVI",
"vrt:hrefs": [
{
"key": "B4",
"href": "#/assets/B4"
},
{
"key": "B5",
"href": "#/assets/B5"
}
],
"title": "Normalized Difference Vegetation Index",
"vrt:algorithm": "band_arithmetic",
"vrt:algorithm_opts": {
"expression": "(B05-B04)/(B05+B04)",
"rescale": [
[
-1,
1
]
]
}
}
},
"bbox": [
-123.00234,
37.82405,
-120.31321,
39.95894
],
"collection": "landsat-8-l1-c1"
}
Loading