Skip to content

Commit

Permalink
docs: smaller section for elevation API
Browse files Browse the repository at this point in the history
  • Loading branch information
@robinbourianes-kalisio
robinbourianes-kalisio committed Jul 12, 2024
1 parent 928a0b3 commit 274385f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ Get an individual tile from the MBTile table (ie. the tile located at `x`,`y`,`z

Return layer metadata in json format.

### /elevation?resolution=res&concurrency=num&demOverride=dem (POST)
### /elevation?resolution=res (POST)

Request an elevation profile computation over the given GeoJSON feature.
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.

The following query parameters are available :

| 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. k2 will auto select a dataset if empty. | `""` |
| `corridorWidth` | The width, in meters, of an imaginary corridor to consider while sampling elevation. The computed elevation will be the max elevation of all the covered samples. | `0` |
| 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. k2 will auto select a dataset if empty. | `""` |
| `corridorWidth` | The width, in meters, of an imaginary corridor to consider while sampling elevation. The computed elevation will be the max elevation of all the covered samples. | `0` |

::: info
The elevation computation will set to `0` any source sample whith a `nodata` value.
Expand Down

0 comments on commit 274385f

Please sign in to comment.