You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versatiles_pipeline/README.md
+82-24Lines changed: 82 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,9 @@ from_stacked [
44
44
45
45
# READ operations
46
46
47
-
## `from_color`
47
+
---
48
+
49
+
## from_color
48
50
49
51
Generates solid-color tiles of the specified size and format.
50
52
@@ -54,23 +56,45 @@ Generates solid-color tiles of the specified size and format.
54
56
-*`size`: u16 (optional)* - Tile size in pixels (256 or 512). Defaults to 512.
55
57
-*`format`: String (optional)* - Tile format: one of "avif", "jpg", "png", or "webp". Defaults to "png".
56
58
57
-
## `from_container`
59
+
---
60
+
61
+
## from_container
58
62
59
63
Reads a tile container, such as a `*.versatiles`, `*.mbtiles`, `*.pmtiles` or `*.tar` file.
60
64
61
65
### Parameters
62
66
63
67
-**`filename`: String (required)** - The filename of the tile container. This is relative to the path of the VPL file. For example: `filename="world.versatiles"`.
64
68
65
-
## `from_debug`
69
+
---
70
+
71
+
## from_debug
66
72
67
73
Generates debug tiles that display their coordinates as text.
68
74
69
75
### Parameters
70
76
71
77
-*`format`: String (optional)* - Target tile format: one of `"mvt"` (default), `"avif"`, `"jpg"`, `"png"` or `"webp"`
72
78
73
-
## `from_gdal_raster`
79
+
---
80
+
81
+
## from_gdal_dem
82
+
83
+
Reads a GDAL DEM dataset and produces terrain RGB tiles (Mapbox or Terrarium encoding).
84
+
85
+
### Parameters
86
+
87
+
-**`filename`: String (required)** - The filename of the GDAL DEM dataset to read. For example: `filename="dem.tif"`.
88
+
-*`encoding`: String (optional)* - The DEM encoding format: `"mapbox"` or `"terrarium"`. (default: `"mapbox"`)
89
+
-*`tile_size`: u32 (optional)* - The size of the generated tiles in pixels. (default: 512)
90
+
-*`level_max`: u8 (optional)* - The maximum zoom level to generate tiles for. (default: the maximum zoom level based on the dataset's native resolution)
91
+
-*`level_min`: u8 (optional)* - The minimum zoom level to generate tiles for. (default: level_max)
92
+
-*`gdal_reuse_limit`: u32 (optional)* - How often to reuse a GDAL instance. (default: 100) Set to a lower value if you have problems like memory leaks in GDAL.
93
+
-*`gdal_concurrency_limit`: u8 (optional)* - The number of maximum concurrent GDAL instances to allow. (default: 4) Set to a higher value if you have enough system resources and want to increase throughput.
94
+
95
+
---
96
+
97
+
## from_gdal_raster
74
98
75
99
Reads a GDAL raster dataset and exposes it as a tile source.
76
100
Hint: When using "gdalbuildvrt" to create a virtual raster, don't forget to set `-addalpha` option to include alpha channel.
@@ -85,7 +109,9 @@ Hint: When using "gdalbuildvrt" to create a virtual raster, don't forget to set
85
109
-*`gdal_reuse_limit`: u32 (optional)* - How often to reuse an GDAL instances. (default: 100) Set to a lower value if you have problems like memory leaks in GDAL.
86
110
-*`gdal_concurrency_limit`: u8 (optional)* - The number of maximum concurrent GDAL instances to allow. (default: 4) Set to a higher value if you have enough system resources and want to increase throughput.
87
111
88
-
## `from_merged_vector`
112
+
---
113
+
114
+
## from_merged_vector
89
115
90
116
Merges multiple vector tile sources.
91
117
Each resulting tile will contain all the features and properties from all the sources.
@@ -94,15 +120,19 @@ Each resulting tile will contain all the features and properties from all the so
94
120
95
121
All tile sources must provide vector tiles.
96
122
97
-
## `from_stacked`
123
+
---
124
+
125
+
## from_stacked
98
126
99
127
Overlays multiple tile sources, using the tile from the first source that provides it.
100
128
101
129
### Sources
102
130
103
131
All tile sources must have the same format.
104
132
105
-
## `from_stacked_raster`
133
+
---
134
+
135
+
## from_stacked_raster
106
136
107
137
Overlays multiple raster tile sources on top of each other.
108
138
@@ -115,15 +145,19 @@ All tile sources must provide raster tiles in the same resolution. The first sou
115
145
-*`format`: TileFormat (optional)* - The tile format to use for the output tiles. Default: format of the first source.
116
146
-*`auto_overscale`: bool (optional)* - Whether to automatically overscale tiles when a source does not provide tiles at the requested zoom level. Default: `false`.
117
147
118
-
## `from_tile`
148
+
---
149
+
150
+
## from_tile
119
151
120
152
Reads a single tile file and uses it as a template for all tile requests.
121
153
122
154
### Parameters
123
155
124
156
-**`filename`: String (required)** - The filename of the tile. Supported formats: png, jpg/jpeg, webp, avif, pbf/mvt. The format is automatically detected from the file extension.
125
157
126
-
## `from_tilejson`
158
+
---
159
+
160
+
## from_tilejson
127
161
128
162
Reads tiles from a remote tile server via a TileJSON endpoint.
129
163
The TileJSON is fetched from the given URL, and tiles are loaded individually
@@ -139,7 +173,9 @@ using the URL template from the TileJSON `tiles` array.
139
173
140
174
# TRANSFORM operations
141
175
142
-
## `dem_quantize`
176
+
---
177
+
178
+
## dem_quantize
143
179
144
180
Quantize DEM (elevation) raster tiles by zeroing unnecessary low bits.
145
181
Computes a per-tile quantization mask from two physically meaningful criteria:
@@ -152,7 +188,9 @@ The stricter (smaller step) wins. Single-pass — no min/max scan needed.
152
188
-*`max_gradient_error`: f64 (optional)* - Maximum allowed gradient change in degrees due to quantization. Defaults to 1.0.
153
189
-*`encoding`: String (optional)* - Override auto-detection of DEM encoding. Values: "mapbox", "terrarium".
Flattens (translucent) raster tiles onto a background
183
225
184
226
### Parameters
185
227
186
228
-*`color`: [u8,u8,u8] (optional)* - background color to use for the flattened tiles, in RGB format. Defaults to white.
187
229
188
-
## `raster_format`
230
+
---
189
231
190
-
Filter tiles by bounding box and/or zoom levels.
232
+
## raster_format
233
+
234
+
Convert raster tiles to a different image format and/or adjust quality/speed settings.
191
235
192
236
### Parameters
193
237
194
238
-*`format`: String (optional)* - The desired tile format. Allowed values are: AVIF, JPG, PNG or WEBP. If not specified, the source format will be used.
195
239
-*`quality`: String (optional)* - Quality level for the tile compression (only AVIF, JPG or WEBP), between 0 (worst) and 100 (lossless). To allow different quality levels for different zoom levels, this can also be a comma-separated list like this: "80,70,14:50,15:20", where the first value is the default quality, and the other values specify the quality for the specified zoom level (and higher).
196
-
-*`speed`: u8 (optional)* - Compression speed (only AVIF), between 0 (slowest) and 100 (fastest).
240
+
-*`speed`: u8 (optional)* - Compression speed, between 0 (slowest) and 100 (fastest).
241
+
242
+
---
197
243
198
-
## `raster_levels`
244
+
## raster_levels
199
245
200
246
Adjust brightness, contrast and gamma of raster tiles.
201
247
@@ -205,7 +251,9 @@ Adjust brightness, contrast and gamma of raster tiles.
205
251
-*`contrast`: f32 (optional)* - Contrast adjustment, between 0 and infinity. Defaults to 1.0 (no change).
206
252
-*`gamma`: f32 (optional)* - Gamma adjustment, between 0 and infinity. Defaults to 1.0 (no change).
207
253
208
-
## `raster_mask`
254
+
---
255
+
256
+
## raster_mask
209
257
210
258
Apply a polygon mask from GeoJSON to raster tiles.
211
259
Pixels outside the polygon become transparent.
@@ -217,7 +265,9 @@ Pixels outside the polygon become transparent.
217
265
-*`blur`: f32 (optional)* - Edge blur distance in meters. Creates a soft transition at the mask edge. Default: 0
-*`level_max`: u8 (optional)* - The maximum zoom level to support. Defaults to 30. Requests above this level will not return tiles.
228
278
-*`enable_climbing`: bool (optional)* - Enable tile climbing when the expected source tile doesn't exist. When true, the operation will search parent tiles at lower zoom levels until it finds an existing tile, then extract and upscale from there. Defaults to false.
229
279
230
-
## `raster_overview`
280
+
---
231
281
232
-
Filter tiles by bounding box and/or zoom levels.
282
+
## raster_overview
283
+
284
+
Generate lower-zoom overview tiles by downscaling from a base zoom level.
233
285
234
286
### Parameters
235
287
236
288
-*`level`: u8 (optional)* - use this zoom level to build the overview. Defaults to the maximum zoom level of the source.
237
289
-*`tile_size`: u32 (optional)* - Size of the tiles in pixels. Defaults to 512.
238
290
239
-
## `vector_filter_layers`
291
+
---
292
+
293
+
## vector_filter_layers
240
294
241
295
Filters vector tile layers based on a comma-separated list of layer names.
242
296
@@ -245,7 +299,9 @@ Filters vector tile layers based on a comma-separated list of layer names.
245
299
-**`filter`: String (required)** - Comma‑separated list of layer names that should be removed from the tiles, e.g.: filter="pois,ocean".
246
300
-*`invert`: bool (optional)* - If set, inverts the filter logic (i.e., keeps only layers matching the filter).
247
301
248
-
## `vector_filter_properties`
302
+
---
303
+
304
+
## vector_filter_properties
249
305
250
306
Filters properties based on a regular expressions.
251
307
@@ -254,7 +310,9 @@ Filters properties based on a regular expressions.
254
310
-**`regex`: String (required)** - A regular expression pattern that should match property names to be removed from all features. The property names contain the layer name as a prefix, e.g., `layer_name/property_name`, so an expression like `regex="^layer_name/"` will match all properties of that layer or `regex="/name_.*$"` will match all properties starting with `name_` in all layers.
255
311
-*`invert`: bool (optional)* - If set, inverts the filter logic (i.e., keeps only properties matching the filter).
256
312
257
-
## `vector_update_properties`
313
+
---
314
+
315
+
## vector_update_properties
258
316
259
317
Arguments for the `vector_update_properties` operation.
260
318
This operation joins vector tile features with external tabular data (CSV/TSV)
0 commit comments