Skip to content
This repository has been archived by the owner on Aug 22, 2023. It is now read-only.

Commit

Permalink
Merge branch 'master' of github.com:Melown/vts-mapproxy
Browse files Browse the repository at this point in the history
  • Loading branch information
vaclavblazek committed Oct 20, 2017
2 parents 41e9824 + b49de2e commit 6704b87
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions docs/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,28 @@ a JSON file on disk (for JSON resource backend) or a python data tree.
* `Boolean`: boolean JSON/python value
* `Array<type>`: array of given type(s)
* `Optional` given entry is optional
* `Enum` string data type limited to enumerated values
* `?` no fixed name

Complex datatypes:

```javascript
ResourceId`: {
ResourceId: {
String group // group this resource belongs to
String id // resource identifier (withing group)
}
```

```javascript
Resampling: Enum {
<GDAL-supported resampling algorithms>
texture
dem
}
```
Where `texture` is resampling suitable for rextures (`average` for scales smaller than 0.5, `cubic` otherwise)
and `dem` is suitable for terrain (`average` for scales smaller than 0.5, `cubicspline` otherwise).

Basic resource layout:

```javascript
Expand Down Expand Up @@ -92,10 +103,11 @@ Raster-based bound layer generator. Uses any raster GDAL dataset as its data sou
```javascript
definition = {
String dataset // path to GDAL dataset
Optional String mask // path to RF mask or masking GDAL dataset
Optional String format // output image format, "jpg" or "png" (defaults to "jpg")
Optional Boolean transparent // Boundlayer is transparent, forces format to "png"
String dataset // path to GDAL dataset
Optional String mask // path to RF mask or masking GDAL dataset
Optional String format // output image format, "jpg" or "png" (defaults to "jpg")
Optional Boolean transparent // Boundlayer is transparent, forces format to "png"
Optional Resampling resampling // Resampling to use for tile texture generation, default 'texture'
}
```
Expand Down Expand Up @@ -138,7 +150,7 @@ Surface drivers generate a meshed surface that can be used directly as a single
a remote tileset.
In addition, a `freelayer.json` file is provided allowing generated surface to act as a `mesh-tiles` free layer.
### Commpon surdace driver configuration options
### Common surface driver configuration options
All surface drivers support these (optional) options:
```javascript
Expand Down Expand Up @@ -167,12 +179,9 @@ introspection = {
This driver generates meshed surface for reference frame's spheroid. If geoid grid is provided the resulting body
is in fact a geoid.
If a `textureLayerId` entry is present this ID is written into generated meshes as a default bound layer to use
if nothing else is mapped on the surface. Otherwise surface is completely texture less.

```javascript
definition = {
Optional Int textureLayerId // numeric bound layer ID
// see common surface driver configuration options above
}
```
Expand All @@ -190,15 +199,14 @@ vertical system to use geoid support. I.e. either they share the same ellipsoid
local system that approximates the geoid at given place. One working example is data in Krovak's projection that can
be reinterpreted as heights above WGS84+EGM96 without any significant error.
If a `textureLayerId` entry is present this ID is written into generated meshes as a default bound layer to use
if nothing else is mapped on the surface. Otherwise surface is completely texture less.

All `surface-dem` input datasets are registered in internal map od available DEM's under its `group-id` identifier
and can be referenced from various `geodata`resources for 2D features heightcofing. Optionially, input dataset can
be registered in this map under an alias. See more in the `geodata` resources documentation.
```javascript
definition = {
// see common surface driver configuration options above

String dataset // path to complex dataset
Optional String mask // optional mask, generated by mapproxy-rf-mask tool
Optional Int textureLayerId // numeric bound layer ID
Expand Down

0 comments on commit 6704b87

Please sign in to comment.