Skip to content

Commit 523bf56

Browse files
committed
Elevation profile image algorithm
1 parent 3095067 commit 523bf56

1 file changed

Lines changed: 155 additions & 0 deletions

File tree

  • docs/user_manual/processing_algs/qgis

docs/user_manual/processing_algs/qgis/plots.rst

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,161 @@ Python code
156156
:end-before: **end_algorithm_code_section**
157157

158158

159+
.. _qgisgenerateelevationprofileimage:
160+
161+
Generate elevation profile image
162+
--------------------------------
163+
164+
Creates an elevation profile image from a list of map layers and an optional terrain layer.
165+
166+
Parameters
167+
..........
168+
169+
.. list-table::
170+
:header-rows: 1
171+
:widths: 20 20 20 40
172+
173+
* - Label
174+
- Name
175+
- Type
176+
- Description
177+
* - **Profile curve**
178+
- ``CURVE``
179+
- [vector: line]
180+
- The line layer representing the profile curve along which the elevation profile will be generated
181+
* - **Map layers**
182+
- ``MAP_LAYERS``
183+
- [multipleLayers]
184+
- The list of map layers to include in the elevation profile
185+
* - **Chart width (in pixels)**
186+
- ``WIDTH``
187+
- [number]
188+
189+
Default: 400
190+
191+
Minimum value: 0
192+
- The width of the output chart in pixels.
193+
* - **Chart height (in pixels)**
194+
- ``HEIGHT``
195+
- [number]
196+
197+
Default: 300
198+
199+
Minimum value: 0
200+
- The height of the output chart in pixels.
201+
* - **Terrain layer**
202+
203+
Optional
204+
- ``TERRAIN_LAYER``
205+
- [raster]
206+
- A terrain layer (e.g., DEM) to use for elevation data. If not provided, elevation data will be derived from the map layers.
207+
208+
Advanced Parameters
209+
...................
210+
211+
.. list-table::
212+
:header-rows: 1
213+
:widths: 20 20 20 40
214+
215+
* - Label
216+
- Name
217+
- Type
218+
- Description
219+
* - **Chart minimum distance (X axis)**
220+
221+
Optional
222+
- ``MINIMUM_DISTANCE``
223+
- [number]
224+
- The minimum distance (X axis) to display on the chart. If not specified, the chart will auto-scale.
225+
* - **Chart maximum distance (X axis)**
226+
227+
Optional
228+
- ``MAXIMUM_DISTANCE``
229+
- [number]
230+
- The maximum distance (X axis) to display on the chart. If not specified, the chart will auto-scale.
231+
* - **Chart minimum elevation (Y axis)**
232+
233+
Optional
234+
- ``MINIMUM_ELEVATION``
235+
- [number]
236+
- The minimum elevation (Y axis) to display on the chart. If not specified, the chart will auto-scale.
237+
* - **Chart maximum elevation (Y axis)**
238+
239+
Optional
240+
- ``MAXIMUM_ELEVATION``
241+
- [number]
242+
- The maximum elevation (Y axis) to display on the chart. If not specified, the chart will auto-scale.
243+
* - **Chart text color**
244+
245+
Optional
246+
- ``TEXT_COLOR``
247+
- [color]
248+
- The color of the text in the chart (e.g., axis labels, titles).
249+
* - **Chart background color**
250+
251+
Optional
252+
- ``BACKGROUND_COLOR``
253+
- [color]
254+
- The background color of the chart.
255+
* - **Chart border color**
256+
257+
Optional
258+
- ``BORDER_COLOR``
259+
- [color]
260+
- The color of the chart border.
261+
* - **Profile tolerance**
262+
- ``TOLERANCE``
263+
- [number]
264+
265+
Default: 5
266+
267+
Minimum value: 0
268+
- The tolerance for sampling points along the profile curve.
269+
* - **Chart DPI**
270+
- ``DPI``
271+
- [number]
272+
273+
Default: 96
274+
275+
Minimum value: 0
276+
- The resolution of the output image in dots per inch (DPI).
277+
* - **Output image**
278+
- ``OUTPUT``
279+
- [file]
280+
281+
Default: ``[Save to temporary file]``
282+
- Specify the image file for the plot. One of:
283+
284+
.. include:: ../algs_include.rst
285+
:start-after: **file_output_types**
286+
:end-before: **end_file_output_types**
287+
288+
Outputs
289+
.......
290+
291+
.. list-table::
292+
:header-rows: 1
293+
:widths: 20 20 20 40
294+
295+
* - Label
296+
- Name
297+
- Type
298+
- Description
299+
* - **Output image**
300+
- ``OUTPUT``
301+
- [file]
302+
- The generated elevation profile image in the specified format.
303+
304+
305+
Python code
306+
...........
307+
308+
**Algorithm ID**: ``qgis:generateelevationprofileimage``
309+
310+
.. include:: ../algs_include.rst
311+
:start-after: **algorithm_code_section**
312+
:end-before: **end_algorithm_code_section**
313+
159314
.. _qgismeanandstandarddeviationplot:
160315

161316
Mean and standard deviation plot

0 commit comments

Comments
 (0)