A lightweight service that exposes different endpoints related to terrain data:
- a 3D terrain tiles endpoint that let you access quantized meshes in MBTiles for Cesium,
- an elevation endpoint that let you compute the elevation of the terrain under a linear geographical element.
Check for service's health, return a json object with a single member isRunning.
Get an individual tile from the MBTile table (ie. the tile located at x,y,z).
Return layer metadata in json format.
Computes the elevation of the terrain under a linear geographical element (i.e. a path/trajectory) based on available elevation data and a requested target resolution. By default, the elevation dataset will be selected depending on the resolution according to the following rules:
- resolution < 250m: SRTM v4,
- resolution < 500m: GMTED 2010 - Maximum 7.5 arc-seconds grid,
- resolution < 1000m: GMTED 2010 - Maximum 15 arc-seconds grid,
- otherwise: GMTED 2010 - Maximum 30 arc-seconds grid.
Warning
When GMTED dataset is selected the maximum elevation within each elevation grid cell will be returned, otherwise the mean elevation is returned.
The elevation endpoint allows to post a body that must conform a GeoJSON feature defining the target geographical element geometry with the following configuration properties:
| Name | Description | Default value |
|---|---|---|
resolution |
Interval, in meters, between two elevation samples over the profile source. | 30 meters |
concurrency |
How many segments will be computed in parallel server side. | 4 |
demOverride |
The name of an elevation dataset to use for custom datasets. k2 will auto select a dataset if empty. | "" |
corridorWidth |
The width, in meters, of a corridor to consider "around" the path for computation. The computed elevation will be the max elevation of all the covered samples. | 0 |
The POST body must contain the GeoJSON to use as elevation profile source. If the GeoJSON is a FeatureCollection, then only the first feature will be used in the computation.
Tip
The configuration properties can also be passed as query parameters.
The endpoint result is a GeoJSON feature collection defining the sample points geometry with the following properties:
zdefines the computed elevation of the sampled point taking margin into account,tdefines the computed curvilinear abscissa of the sampled point along the path.
Important
The elevation computation will set to 0 any source sample whith a nodata value.
You can build the image with the following command:
docker build -t <your-image-name> .This project is configured to use GitHub Actions to build and push the image on the Kalisio's Docker Hub.
The built image is tagged using the version property in the package.json file.
This image is designed to be deployed using the Kargo project.
Check out the compose file to have an overview on how the container is deployed.
Please read the Contributing file for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
When releasing a patch, minor or major version, i.e. the following tasks have to be done:
- increase the package version number in the package.json file
- create a tag accordingly in the git repository and push it
The command npm run release:<type>, where <type> is either patch, minor or major, will do the job for you !
This project is sponsored by
This project is licensed under the MIT License - see the license file for details