-
Notifications
You must be signed in to change notification settings - Fork 0
Resource
Daniel Santillan edited this page Nov 12, 2024
·
12 revisions
Following resource types are supported:
- SentinelHub - Allows integration of dataset
- GeoDB
- GeoDB Vector Tile
- WMS
- Visualization, Exploration, and Data Analysis (VEDA)
- XCube Server
- Copernicus Marine Data Store WMTS
- rasdaman WCS
Different resources require different parameters but multiple are shared, still in order to help find the required ones they are described per resource type:
In order to integrate a SH dataset a client id and secret needs to be configured for catalog access, also the collection id is needed for BYOC datasets, not only the layer id.
Element | Type | Description |
---|---|---|
EndPoint | string | Url to resource endpoint, usually https://services.sentinel-hub.com
|
Name | string | Sentinel Hub |
Type | string | Can either be byoc or zarr depending on the data type used for the collection |
CollectionId | string | Identifier of the underlying dataset in SH (looks like a hash) |
LayerId | string | Identifier for configured visualization (WMS) layer in SH |
This endpoint is intended to allow manually defining locations and times for public sentinelhub collections. This is a very specific use case that will probably not be needed by an external integrator. Requires Locations definition which provide areas and times!
Element | Type | Description |
---|---|---|
EndPoint | string | Url to resource endpoint, usually https://services.sentinel-hub.com
|
Name | string | Sentinel Hub WMS |
CollectionId | string | Identifier of the underlying public dataset in SH |
LayerId | string | Identifier for configured visualization (WMS) layer in SH |
Element | Type | Description |
---|---|---|
EndPoint | string | Url to GeoDB instance, usually https://xcube-geodb.brockmann-consult.de// |
Name | string | GeoDB |
Database | string | Identifier of the database containing the collection in geoDB |
CollectionId | string | Identifier of the table/collection containing the data |
AdditionalQueryString | string | Optional query parameters to be appended to the postgrest query |
IdKey | string | Optional name of column to use for value of ID of the STAC Item. Default value: city
|
Element | Type | Description |
---|---|---|
EndPoint | string | Url to WMS endpoint |
Name | string | WMS |
Type | string | If WMS layer contains a time domain the type Time should be added to parse the capabilities of the service |
LayerId | string | Identifier of WMS layer to be displayed |
Styles | [string] | List of styles to be added to the request when visualizing the data |
Version | string | Optional version string (defaults to 1.3.0 ), options are 1.1.0 . |
TileSize | number | Optional tilesize value to be used in requests (defaults to 512 ) |
Element | Type | Description |
---|---|---|
EndPoint | string | Url to endpoint, usually https://staging-stac.delta-backend.com/
|
Name | string | VEDA |
Type | string | Can either be tiles or cog
|
CollectionId | string | Identifier of the VEDA collection to be integrated |
ColormapName | string | Name of the colormap used for visualizing the data, following are available: accent, accent_r, afmhot, afmhot_r, autumn, autumn_r, binary, binary_r, blues, blues_r, bone, bone_r, brbg, brbg_r, brg, brg_r, bugn, bugn_r, bupu, bupu_r, bwr, bwr_r, cfastie, cividis, cividis_r, cmrmap, cmrmap_r, cool, cool_r, coolwarm, coolwarm_r, copper, copper_r, cubehelix, cubehelix_r, dark2, dark2_r, flag, flag_r, gist_earth, gist_earth_r, gist_gray, gist_gray_r, gist_heat, gist_heat_r, gist_ncar, gist_ncar_r, gist_rainbow, gist_rainbow_r, gist_stern, gist_stern_r, gist_yarg, gist_yarg_r, gnbu, gnbu_r, gnuplot, gnuplot2, gnuplot2_r, gnuplot_r, gray, gray_r, greens, greens_r, greys, greys_r, hot, hot_r, hsv, hsv_r, inferno, inferno_r, jet, jet_r, magma, magma_r, nipy_spectral, nipy_spectral_r, ocean, ocean_r, oranges, oranges_r, orrd, orrd_r, paired, paired_r, pastel1, pastel1_r, pastel2, pastel2_r, pink, pink_r, piyg, piyg_r, plasma, plasma_r, prgn, prgn_r, prism, prism_r, pubu, pubu_r, pubugn, pubugn_r, puor, puor_r, purd, purd_r, purples, purples_r, rainbow, rainbow_r, rdbu, rdbu_r, rdgy, rdgy_r, rdpu, rdpu_r, rdylbu, rdylbu_r, rdylgn, rdylgn_r, reds, reds_r, rplumbo, schwarzwald, seismic, seismic_r, set1, set1_r, set2, set2_r, set3, set3_r, spectral, spectral_r, spring, spring_r, summer, summer_r, tab10, tab10_r, tab20, tab20_r, tab20b, tab20b_r, tab20c, tab20c_r, terrain, terrain_r, twilight, twilight_r, twilight_shifted, twilight_shifted_r, viridis, viridis_r, winter, winter_r, wistia, wistia_r, ylgn, ylgn_r, ylgnbu, ylgnbu_r, ylorbr, ylorbr_r, ylorrd, ylorrd_r |
Rescale | [float,float] | Minimum and maximum values for rescaling the data |
Bidx | int | Required if using type cog Band index for data, usually will be 1 |
Assets | [string] | Required for type tiles List of assets to be used for tiles |
ColorFormula | string | Required for type tiles colorformula to be applied for rendering of tiles |
Element | Type | Description |
---|---|---|
EndPoint | string | Url to geoserver instance endpoint, https://xcube-geodb.brockmann-consult.de/geoserver/<instance_id>/gwc/service/tms/1.0.0/ |
Name | string | GeoDB Vector Tiles |
DBEndpoint | string | Url to geodb postgrest endpoint, https://xcube-geodb.brockmann-consult.de//<instance_id>/ |
Source | string | Identifier of table containing the data to be rendered as fill color of features |
Instance | string | GeoDB instance identifier |
Database | string | Identifier geoDB Database identifier |
CollectionId | string | Identifier of collection containing vector feature information of vector tiles |
TimeKey | string | Identifier of table parameter that contains time information |
MatchKey | string | Identifier of table parameter that will be used to match with vector tile features |
Parameters | [string] | List of parameter identifiers which will be retrieved from the database |
Element | Type | Description | Example |
---|---|---|---|
EndPoint | string | Url to XCube Server API endpoint | https://sampleurl.com/api |
Name | string | Fixed to xcube
|
xcube |
Type | string | Fixed to zarr
|
zarr |
StacEndpoint | string | Endpoint where the STAC catalog served is served. | /stac |
DatacubeId | string | Name of the datacube to extract. | esdc |
Variable | string | Variable to extract from the datacube | KNDVI |
ColormapName | string | Default colormap to use for tiles visualisation. See /colormaps.html endpoint of XCube server for available | rain |
Rescale | [float,float] | Minimum and maximum values for rescaling the data | [0,5] |
Element | Type | Description | Example |
---|---|---|---|
EndPoint | string | Url to WMTS endpoint of dataset | https://wmts.marine.copernicus.eu/teroWmts/OCEANCOLOUR_ATL_BGC_L4_NRT_009_116/cmems_obs-oc_atl_bgc-plankton_nrt_l4-gapfree-multi-1km_P1D_202311 |
Name | string | Fixed to marinedatastore
|
marinedatastore |
Type | string | Fixed to WMTSCapabilities
|
WMTSCapabilities |
LayerId | string | WMTS Layer name | OCEANCOLOUR_ATL_BGC_L4_NRT_009_116 |
Variable | string | Variable to extract from the datacube | KNDVI |
Dimensions | mapping | Mapping of key:value parameters to add to the WMTS request. Their services is adding new features often. For latest guide, see here | style: 'cmap:rainbow,range:0.03/50,noClamp,logScale' |
Query | mapping | Optional mapping with two allowed keys: Start and End accepting a datetime string for limitting the start and end time of collection. | Start: "2018-01-01T00:00:00Z" End: "2022-12-31T00:00:00Z" |
Assumes availability of WCS and WMS services under the provided endpoint.
Element | Type | Description |
---|---|---|
EndPoint | string | Url to OWS endpoint, e.g. https://exampleurl.org/ows |
Name | string | rasdaman |
CoverageId | string | Identifier of WCS Coverage (datacube) to be displayed |