Elevation profile image algorithm (#9726)

Author: DelazJ

docs/user_manual/processing_algs/qgis/plots.rst

@@ -156,6 +156,166 @@ Python code
   :end-before: **end_algorithm_code_section**
 
 
+.. _qgisgenerateelevationprofileimage:
+
+Generate elevation profile image
+--------------------------------
+
+Creates an elevation profile image from a list of map layers and an optional terrain layer.
+
+Parameters
+..........
+
+Basic parameters
+^^^^^^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 20 20 40
+
+   * - Label
+     - Name
+     - Type
+     - Description
+   * - **Profile curve**
+     - ``CURVE``
+     - [vector: line]
+     - The line layer representing the profile curve along which the elevation profile will be generated
+   * - **Map layers**
+     - ``MAP_LAYERS``
+     - [layer] [list]
+     - The list of map layers to include in the elevation profile
+   * - **Chart width (in pixels)**
+     - ``WIDTH``
+     - [number]
+
+       Default: 400
+
+       Minimum value: 0
+     - The width of the output chart in pixels.
+   * - **Chart height (in pixels)**
+     - ``HEIGHT``
+     - [number]
+
+       Default: 300
+
+       Minimum value: 0
+     - The height of the output chart in pixels.
+   * - **Terrain layer**
+
+       Optional
+     - ``TERRAIN_LAYER``
+     - [raster]
+     - A terrain layer (e.g., DEM) to use for elevation data. If not provided, elevation data will be derived from the map layers.
+
+Advanced parameters
+^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 20 20 40
+
+   * - Label
+     - Name
+     - Type
+     - Description
+   * - **Chart minimum distance (X axis)**
+
+       Optional
+     - ``MINIMUM_DISTANCE``
+     - [number]
+     - The minimum distance (X axis) to display on the chart. If not specified, the chart will auto-scale.
+   * - **Chart maximum distance (X axis)**
+
+       Optional
+     - ``MAXIMUM_DISTANCE``
+     - [number]
+     - The maximum distance (X axis) to display on the chart. If not specified, the chart will auto-scale.
+   * - **Chart minimum elevation (Y axis)**
+
+       Optional
+     - ``MINIMUM_ELEVATION``
+     - [number]
+     - The minimum elevation (Y axis) to display on the chart. If not specified, the chart will auto-scale.
+   * - **Chart maximum elevation (Y axis)**
+
+       Optional
+     - ``MAXIMUM_ELEVATION``
+     - [number]
+     - The maximum elevation (Y axis) to display on the chart. If not specified, the chart will auto-scale.
+   * - **Chart text color**
+
+       Optional
+     - ``TEXT_COLOR``
+     - [color]
+     - The color of the text in the chart (e.g., axis labels, titles).
+   * - **Chart background color**
+
+       Optional
+     - ``BACKGROUND_COLOR``
+     - [color]
+     - The background color of the chart.
+   * - **Chart border color**
+
+       Optional
+     - ``BORDER_COLOR``
+     - [color]
+     - The color of the chart border.
+   * - **Profile tolerance**
+     - ``TOLERANCE``
+     - [number]
+
+       Default: 5
+
+       Minimum value: 0
+     - Defines how far a feature (vector point, line, polygon, or point cloud)
+       can be from the profile line to be included in the results. It uses map units
+       and does not affect other layer types.
+   * - **Chart DPI**
+     - ``DPI``
+     - [number]
+
+       Default: 96
+
+       Minimum value: 0
+     - The resolution of the output image in dots per inch (DPI).
+   * - **Output image**
+     - ``OUTPUT``
+     - [file]
+
+       Default: ``[Save to temporary file]``
+     - Specify the image file for the plot. One of:
+
+       .. include:: ../algs_include.rst
+          :start-after: **file_output_types**
+          :end-before: **end_file_output_types**
+
+Outputs
+.......
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 20 20 40
+
+   * - Label
+     - Name
+     - Type
+     - Description
+   * - **Output image**
+     - ``OUTPUT``
+     - [file]
+     - The generated elevation profile image in the specified format.
+
+
+Python code
+...........
+
+**Algorithm ID**: ``qgis:generateelevationprofileimage``
+
+.. include:: ../algs_include.rst
+  :start-after: **algorithm_code_section**
+  :end-before: **end_algorithm_code_section**
+
 .. _qgismeanandstandarddeviationplot:
 
 Mean and standard deviation plot